Package software.amazon.awssdk.services.gamelift.model

Class GameProperty

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameProperty

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class GameProperty
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GameProperty.Builder,GameProperty>

This key-value pair can store custom data about a game session. For example, you might use a GameProperty to track a game session's map, level of difficulty, or remaining time. The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"}.

You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.

For examples of working with game properties, see Create a game session with properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GameProperty.Builder

Method Summary

Modifier and Type	Method	Description
static GameProperty.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The game property identifier.
List<SdkField<?>>	sdkFields()
static Class<? extends GameProperty.Builder>	serializableBuilderClass()
GameProperty.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The game property value.

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

key

public final String key()

The game property identifier.

Returns:

The game property identifier.

value

public final String value()

The game property value.

Returns:

The game property value.

toBuilder

public GameProperty.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameProperty.Builder,GameProperty>

builder

public static GameProperty.Builder builder()

serializableBuilderClass

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