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

Class CreatePlayerSessionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.CreatePlayerSessionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePlayerSessionsRequest.Builder,CreatePlayerSessionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePlayerSessionsRequest
extends GameLiftRequest
implements ToCopyableBuilder<CreatePlayerSessionsRequest.Builder,CreatePlayerSessionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePlayerSessionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePlayerSessionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameSessionId()	A unique identifier for the game session to add players to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPlayerDataMap()	For responses, this returns true if the service returned a value for the PlayerDataMap property.
boolean	hasPlayerIds()	For responses, this returns true if the service returned a value for the PlayerIds property.
Map<String,String>	playerDataMap()	Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player.
List<String>	playerIds()	List of unique identifiers for the players to be added.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePlayerSessionsRequest.Builder>	serializableBuilderClass()
CreatePlayerSessionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

gameSessionId

public final String gameSessionId()

A unique identifier for the game session to add players to.

Returns:

A unique identifier for the game session to add players to.

hasPlayerIds

public final boolean hasPlayerIds()

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

playerIds

public final List<String> playerIds()

List of unique identifiers for the players to be added.

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

Returns:

List of unique identifiers for the players to be added.

hasPlayerDataMap

public final boolean hasPlayerDataMap()

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

playerDataMap

public final Map<String,String> playerDataMap()

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter 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 hasPlayerDataMap() method.

Returns:

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

toBuilder

public CreatePlayerSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePlayerSessionsRequest.Builder,CreatePlayerSessionsRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static CreatePlayerSessionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePlayerSessionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo