Class AttributeValue
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AttributeValue.Builder,
AttributeValue>
Values for use in player attribute key-value pairs. This object lets you specify an attribute value using any of the
valid data types: string, number, string array, or data map. Each AttributeValue
object can use only one
of the available properties.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AttributeValue.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasSdm()
For responses, this returns true if the service returned a value for the SDM property.final boolean
hasSl()
For responses, this returns true if the service returned a value for the SL property.final Double
n()
For number values, expressed as double.final String
s()
For single string values.sdm()
For a map of up to 10 data type:value pairs.static Class
<? extends AttributeValue.Builder> sl()
For a list of up to 100 strings.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
s
For single string values. Maximum string length is 100 characters.
- Returns:
- For single string values. Maximum string length is 100 characters.
-
n
For number values, expressed as double.
- Returns:
- For number values, expressed as double.
-
hasSl
public final boolean hasSl()For responses, this returns true if the service returned a value for the SL 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. -
sl
For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
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
hasSl()
method.- Returns:
- For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
-
hasSdm
public final boolean hasSdm()For responses, this returns true if the service returned a value for the SDM 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. -
sdm
For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
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
hasSdm()
method.- Returns:
- For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
-
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<AttributeValue.Builder,
AttributeValue> - 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
-
sdkFields
-