software.amazon.awssdk.services.gamelift.model

Class AttributeValue

java.lang.Object

software.amazon.awssdk.services.gamelift.model.AttributeValue

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class AttributeValue
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AttributeValue.Builder

Method Summary

Modifier and Type	Method and Description
static AttributeValue.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSdm() For responses, this returns true if the service returned a value for the SDM property.
boolean	hasSl() For responses, this returns true if the service returned a value for the SL property.
Double	n() For number values, expressed as double.
String	s() For single string values.
List<SdkField<?>>	sdkFields()
Map<String,Double>	sdm() For a map of up to 10 data type:value pairs.
static Class<? extends AttributeValue.Builder>	serializableBuilderClass()
List<String>	sl() For a list of up to 100 strings.
AttributeValue.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

s

public final String s()

For single string values. Maximum string length is 100 characters.

Returns:

For single string values. Maximum string length is 100 characters.

n

public final Double 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 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.

sl

public final List<String> 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 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.

sdm

public final Map<String,Double> 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

public AttributeValue.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributeValue.Builder,AttributeValue>

builder

public static AttributeValue.Builder builder()

serializableBuilderClass

public static Class<? extends AttributeValue.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