Package software.amazon.awssdk.services.kendra.model

Class DocumentAttribute

java.lang.Object

software.amazon.awssdk.services.kendra.model.DocumentAttribute

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentAttribute.Builder,DocumentAttribute>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentAttribute
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentAttribute.Builder,DocumentAttribute>

A document attribute or metadata field. To create custom document attributes, see Custom attributes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentAttribute.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentAttribute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The identifier for the attribute.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentAttribute.Builder>	serializableBuilderClass()
DocumentAttribute.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DocumentAttributeValue	value()	The value of the attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final String key()

The identifier for the attribute.

Returns:

The identifier for the attribute.

value

public final DocumentAttributeValue value()

The value of the attribute.

Returns:

The value of the attribute.

toBuilder

public DocumentAttribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAttribute.Builder,DocumentAttribute>

builder

public static DocumentAttribute.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentAttribute.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo