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

Interface CreateGameSessionRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>, SdkBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

Enclosing class:

CreateGameSessionRequest

public static interface CreateGameSessionRequest.Builder
extends CopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>

Method Summary

Modifier and Type	Method	Description
CreateGameSessionRequest.Builder	aliasId(String aliasId)	Unique identifier for an alias associated with the fleet to create a game session in.
CreateGameSessionRequest.Builder	creatorId(String creatorId)	Unique identifier for a player or entity creating the game session.
CreateGameSessionRequest.Builder	fleetId(String fleetId)	Unique identifier for a fleet to create a game session in.
CreateGameSessionRequest.Builder	gameProperties(Collection<GameProperty> gameProperties)	Set of developer-defined properties for a game session.
CreateGameSessionRequest.Builder	gameProperties(GameProperty... gameProperties)	Set of developer-defined properties for a game session.
CreateGameSessionRequest.Builder	gameSessionId(String gameSessionId)	This parameter is no longer preferred.
CreateGameSessionRequest.Builder	idempotencyToken(String idempotencyToken)	Custom string that uniquely identifies a request for a new game session.
CreateGameSessionRequest.Builder	maximumPlayerSessionCount(Integer maximumPlayerSessionCount)	Maximum number of players that can be connected simultaneously to the game session.
CreateGameSessionRequest.Builder	name(String name)	Descriptive label that is associated with a game session.

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

copy

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

apply, build

Method Detail

fleetId

CreateGameSessionRequest.Builder fleetId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

aliasId

CreateGameSessionRequest.Builder aliasId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maximumPlayerSessionCount

CreateGameSessionRequest.Builder maximumPlayerSessionCount(Integer maximumPlayerSessionCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateGameSessionRequest.Builder name(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

gameProperties

CreateGameSessionRequest.Builder gameProperties(Collection<GameProperty> gameProperties)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

gameProperties

CreateGameSessionRequest.Builder gameProperties(GameProperty... gameProperties)

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

NOTE: This method appends the values to the existing list (if any). Use #setGameProperties(java.util.Collection) or #withGameProperties(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

creatorId

CreateGameSessionRequest.Builder creatorId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

gameSessionId

CreateGameSessionRequest.Builder gameSessionId(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> .)

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

idempotencyToken

CreateGameSessionRequest.Builder idempotencyToken(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> .)

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.