Class DocumentAttributeValue
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentAttributeValue.Builder,
DocumentAttributeValue>
The value of a document attribute. You can only provide one value for a document attribute.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
A date expressed as an ISO 8601 string.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static DocumentAttributeValue
fromDateValue
(Instant dateValue) Create an instance of this class withdateValue()
initialized to the given value.static DocumentAttributeValue
fromLongValue
(Long longValue) Create an instance of this class withlongValue()
initialized to the given value.static DocumentAttributeValue
fromStringListValue
(List<String> stringListValue) Create an instance of this class withstringListValue()
initialized to the given value.static DocumentAttributeValue
fromStringValue
(String stringValue) Create an instance of this class withstringValue()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StringListValue property.final Long
A long integer value.static Class
<? extends DocumentAttributeValue.Builder> A list of strings.final String
A string.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stringValue
A string.
- Returns:
- A string.
-
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 theisEmpty()
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
A list of strings.
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.
-
longValue
A long integer value.
- Returns:
- A long integer value.
-
dateValue
A date expressed as an ISO 8601 string.
It's 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's 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocumentAttributeValue.Builder,
DocumentAttributeValue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromStringValue
Create an instance of this class withstringValue()
initialized to the given value.A string.
- Parameters:
stringValue
- A string.
-
fromStringListValue
Create an instance of this class withstringListValue()
initialized to the given value.A list of strings.
- Parameters:
stringListValue
- A list of strings.
-
fromLongValue
Create an instance of this class withlongValue()
initialized to the given value.A long integer value.
- Parameters:
longValue
- A long integer value.
-
fromDateValue
Create an instance of this class withdateValue()
initialized to the given value.A date expressed as an ISO 8601 string.
It's 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's 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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beDocumentAttributeValue.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 beDocumentAttributeValue.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-