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 document attribute. You can only provide one value for a document attribute.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentAttributeValue.Builder
static class	DocumentAttributeValue.Type

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)
static DocumentAttributeValue	fromDateValue(Instant dateValue) Create an instance of this class with dateValue() initialized to the given value.
static DocumentAttributeValue	fromLongValue(Long longValue) Create an instance of this class with longValue() initialized to the given value.
static DocumentAttributeValue	fromStringListValue(List<String> stringListValue) Create an instance of this class with stringListValue() initialized to the given value.
static DocumentAttributeValue	fromStringValue(String stringValue) Create an instance of this class with stringValue() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStringListValue() For responses, this returns true if the service returned a value for the StringListValue property.
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.
DocumentAttributeValue.Type	type() Retrieve an enum value representing which member of this object is populated.

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 final String stringValue()

A string, such as "department".

Returns:

A string, such as "department".

hasStringListValue

public final boolean hasStringListValue()

For responses, this returns true if the service returned a value for the StringListValue property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stringListValue

public final List<String> stringListValue()

A list of strings. The default maximum length or number of strings is 10.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStringListValue() method.

Returns:

A list of strings. The default maximum length or number of strings is 10.

longValue

public final Long longValue()

A long integer value.

Returns:

A long integer value.

dateValue

public final Instant dateValue()

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Returns:

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

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 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)

fromStringValue

public static DocumentAttributeValue fromStringValue(String stringValue)

Create an instance of this class with stringValue() initialized to the given value.

A string, such as "department".

Parameters:

stringValue - A string, such as "department".

fromStringListValue

public static DocumentAttributeValue fromStringListValue(List<String> stringListValue)

Create an instance of this class with stringListValue() initialized to the given value.

A list of strings. The default maximum length or number of strings is 10.

Parameters:

stringListValue - A list of strings. The default maximum length or number of strings is 10.

fromLongValue

public static DocumentAttributeValue fromLongValue(Long longValue)

Create an instance of this class with longValue() initialized to the given value.

A long integer value.

Parameters:

longValue - A long integer value.

fromDateValue

public static DocumentAttributeValue fromDateValue(Instant dateValue)

Create an instance of this class with dateValue() initialized to the given value.

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Parameters:

dateValue - A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

type

public DocumentAttributeValue.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo