software.amazon.awssdk.services.gamelift.model

Class CreateGameSessionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

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

Represents the input for a request operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGameSessionRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	aliasId() A unique identifier for an alias associated with the fleet to create a game session in.
static CreateGameSessionRequest.Builder	builder()
String	creatorId() A unique identifier for a player or entity creating the game session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId() A unique identifier for a fleet to create a game session in.
List<GameProperty>	gameProperties() Set of custom properties for a game session, formatted as key:value pairs.
String	gameSessionData() Set of custom game session properties, formatted as a single string value.
String	gameSessionId() This parameter is no longer preferred.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasGameProperties() Returns true if the GameProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	idempotencyToken() Custom string that uniquely identifies a request for a new game session.
Integer	maximumPlayerSessionCount() The maximum number of players that can be connected simultaneously to the game session.
String	name() A descriptive label that is associated with a game session.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGameSessionRequest.Builder>	serializableBuilderClass()
CreateGameSessionRequest.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

fleetId

public String fleetId()

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

aliasId

public String aliasId()

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

maximumPlayerSessionCount

public Integer maximumPlayerSessionCount()

The maximum number of players that can be connected simultaneously to the game session.

Returns:

The maximum number of players that can be connected simultaneously to the game session.

name

public String name()

A descriptive label that is associated with a game session. Session names do not need to be unique.

Returns:

A descriptive label that is associated with a game session. Session names do not need to be unique.

hasGameProperties

public boolean hasGameProperties()

Returns true if the GameProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

gameProperties

public List<GameProperty> gameProperties()

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

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

You can use hasGameProperties() to see if a value was sent in this field.

Returns:

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

creatorId

public String creatorId()

A unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Returns:

A unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

gameSessionId

public String gameSessionId()

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .)

Returns:

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .)

idempotencyToken

public String idempotencyToken()

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Returns:

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

gameSessionData

public String gameSessionData()

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Returns:

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

toBuilder

public CreateGameSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static CreateGameSessionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo