com.amazonaws.services.gamelift.model

Class AttributeValue

java.lang.Object

com.amazonaws.services.gamelift.model.AttributeValue

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttributeValue
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeValue()

Method Summary

Modifier and Type	Method and Description
AttributeValue	addSDMEntry(String key, Double value) Add a single SDM entry
AttributeValue	clearSDMEntries() Removes all the entries added into SDM.
AttributeValue	clone()
boolean	equals(Object obj)
Double	getN() For number values, expressed as double.
String	getS() For single string values.
Map<String,Double>	getSDM() For a map of up to 10 data type:value pairs.
List<String>	getSL() For a list of up to 100 strings.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setN(Double n) For number values, expressed as double.
void	setS(String s) For single string values.
void	setSDM(Map<String,Double> sDM) For a map of up to 10 data type:value pairs.
void	setSL(Collection<String> sL) For a list of up to 100 strings.
String	toString() Returns a string representation of this object.
AttributeValue	withN(Double n) For number values, expressed as double.
AttributeValue	withS(String s) For single string values.
AttributeValue	withSDM(Map<String,Double> sDM) For a map of up to 10 data type:value pairs.
AttributeValue	withSL(Collection<String> sL) For a list of up to 100 strings.
AttributeValue	withSL(String... sL) For a list of up to 100 strings.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeValue

public AttributeValue()

Method Detail

setS

public void setS(String s)

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

Parameters:

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

getS

public String getS()

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

Returns:

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

withS

public AttributeValue withS(String s)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setN

public void setN(Double n)

For number values, expressed as double.

Parameters:

n - For number values, expressed as double.

getN

public Double getN()

For number values, expressed as double.

Returns:

For number values, expressed as double.

withN

public AttributeValue withN(Double n)

For number values, expressed as double.

Parameters:

n - For number values, expressed as double.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSL

public List<String> getSL()

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.

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.

setSL

public void setSL(Collection<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.

Parameters:

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.

withSL

public AttributeValue withSL(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.

NOTE: This method appends the values to the existing list (if any). Use setSL(java.util.Collection) or withSL(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSL

public AttributeValue withSL(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSDM

public Map<String,Double> getSDM()

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

Returns:

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

setSDM

public void setSDM(Map<String,Double> sDM)

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

Parameters:

sDM - For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

withSDM

public AttributeValue withSDM(Map<String,Double> sDM)

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

Parameters:

sDM - For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

addSDMEntry

public AttributeValue addSDMEntry(String key,
                                  Double value)

Add a single SDM entry

See Also:

withSDM(java.util.Map<java.lang.String, java.lang.Double>)

clearSDMEntries

public AttributeValue clearSDMEntries()

Removes all the entries added into SDM.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AttributeValue clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.