software.amazon.awssdk.services.gamesparks.model

Class GameSummary

java.lang.Object

software.amazon.awssdk.services.gamesparks.model.GameSummary

All Implemented Interfaces:

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

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

The summary of the properties of a game.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameSummary.Builder

Method Summary

Modifier and Type	Method and Description
static GameSummary.Builder	builder()
String	description() The description of the game.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the game.
List<SdkField<?>>	sdkFields()
static Class<? extends GameSummary.Builder>	serializableBuilderClass()
GameState	state() The state of the game.
String	stateAsString() The state of the game.
Map<String,String>	tags() The tags associated with the game.
GameSummary.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

description

public final String description()

The description of the game.

Returns:

The description of the game.

name

public final String name()

The name of the game.

Returns:

The name of the game.

state

public final GameState state()

The state of the game.

If the service returns an enum value that is not available in the current SDK version, state will return GameState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the game.

See Also:

GameState

stateAsString

public final String stateAsString()

The state of the game.

If the service returns an enum value that is not available in the current SDK version, state will return GameState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the game.

See Also:

GameState

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

The tags associated with the game.

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 hasTags() method.

Returns:

The tags associated with the game.

toBuilder

public GameSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameSummary.Builder,GameSummary>

builder

public static GameSummary.Builder builder()

serializableBuilderClass

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