software.amazon.awssdk.services.kendra.model

Class DocumentAttributeValue

java.lang.Object

software.amazon.awssdk.services.kendra.model.DocumentAttributeValue

All Implemented Interfaces:

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

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

The value of a custom document attribute. You can only provide one value for a custom attribute.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentAttributeValue.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentAttributeValue.Builder	builder()
Instant	dateValue() A date expressed as an ISO 8601 string.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStringListValue() Returns true if the StringListValue property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Long	longValue() A long integer value.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentAttributeValue.Builder>	serializableBuilderClass()
List<String>	stringListValue() A list of strings.
String	stringValue() A string, such as "department".
DocumentAttributeValue.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

stringValue

public String stringValue()

A string, such as "department".

Returns:

A string, such as "department".

hasStringListValue

public boolean hasStringListValue()

Returns true if the StringListValue property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

stringListValue

public List<String> stringListValue()

A list of strings.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasStringListValue() to see if a value was sent in this field.

Returns:

A list of strings.

longValue

public Long longValue()

A long integer value.

Returns:

A long integer value.

dateValue

public Instant dateValue()

A date expressed as an ISO 8601 string.

Returns:

A date expressed as an ISO 8601 string.

toBuilder

public DocumentAttributeValue.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAttributeValue.Builder,DocumentAttributeValue>

builder

public static DocumentAttributeValue.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo