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

Class CreateGameSessionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.gamelift.model.CreateGameSessionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateGameSessionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	aliasId()	Unique identifier for an alias associated with the fleet to create a game session in.
static CreateGameSessionRequest.Builder	builder()
String	creatorId()	Unique identifier for a player or entity creating the game session.
boolean	equals(Object obj)
String	fleetId()	Unique identifier for a fleet to create a game session in.
List<GameProperty>	gameProperties()	Set of developer-defined properties for a game session.
String	gameSessionId()	This parameter is no longer preferred.
int	hashCode()
String	idempotencyToken()	Custom string that uniquely identifies a request for a new game session.
Integer	maximumPlayerSessionCount()	Maximum number of players that can be connected simultaneously to the game session.
String	name()	Descriptive label that is associated with a game session.
static Class<? extends CreateGameSessionRequest.Builder>	serializableBuilderClass()
CreateGameSessionRequest.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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

fleetId

public String fleetId()

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

aliasId

public String aliasId()

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Returns:

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

maximumPlayerSessionCount

public Integer maximumPlayerSessionCount()

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

Returns:

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

name

public String name()

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

Returns:

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

gameProperties

public List<GameProperty> gameProperties()

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

Returns:

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

creatorId

public String creatorId()

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:

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 ID 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 ID 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 ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .)

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 ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .)

toBuilder

public CreateGameSessionRequest.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<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

Returns:

a builder for type T

builder

public static CreateGameSessionRequest.Builder builder()

serializableBuilderClass

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