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:

ToCopyableBuilder<CreatePlayerSessionsRequest.Builder,CreatePlayerSessionsRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePlayerSessionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreatePlayerSessionsRequest.Builder	builder()
boolean	equals(Object obj)
String	gameSessionId() Unique identifier for the game session to add players to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
static Class<? extends CreatePlayerSessionsRequest.Builder>	serializableBuilderClass()
CreatePlayerSessionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

gameSessionId

public String gameSessionId()

Unique identifier for the game session to add players to.

Returns:

Unique identifier for the game session to add players to.

playerIds

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

Returns:

List of unique identifiers for the players to be added.

playerDataMap

public 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. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

toBuilder

public CreatePlayerSessionsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePlayerSessionsRequest.Builder,CreatePlayerSessionsRequest>

Specified by:

toBuilder in class GameLiftRequest

Returns:

a builder for type T

builder

public static CreatePlayerSessionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value