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

Interface GameSession.Builder

All Superinterfaces:

CopyableBuilder<GameSession.Builder,GameSession>, SdkBuilder<GameSession.Builder,GameSession>

Enclosing class:

GameSession

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

Method Summary

Modifier and Type	Method	Description
GameSession.Builder	creationTime(Date creationTime)	Time stamp indicating when this data object was created.
GameSession.Builder	creatorId(String creatorId)	Unique identifier for a player.
GameSession.Builder	currentPlayerSessionCount(Integer currentPlayerSessionCount)	Number of players currently in the game session.
GameSession.Builder	fleetId(String fleetId)	Unique identifier for a fleet the game session is running on.
GameSession.Builder	gameProperties(Collection<GameProperty> gameProperties)	Set of developer-defined properties for a game session.
GameSession.Builder	gameProperties(GameProperty... gameProperties)	Set of developer-defined properties for a game session.
GameSession.Builder	gameSessionId(String gameSessionId)	Unique identifier for the game session.
GameSession.Builder	ipAddress(String ipAddress)	IP address of the game session.
GameSession.Builder	maximumPlayerSessionCount(Integer maximumPlayerSessionCount)	Maximum number of players that can be connected simultaneously to the game session.
GameSession.Builder	name(String name)	Descriptive label that is associated with a game session.
GameSession.Builder	playerSessionCreationPolicy(String playerSessionCreationPolicy)	Indicates whether or not the game session is accepting new players.
GameSession.Builder	playerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)	Indicates whether or not the game session is accepting new players.
GameSession.Builder	port(Integer port)	Port number for the game session.
GameSession.Builder	status(String status)	Current status of the game session.
GameSession.Builder	status(GameSessionStatus status)	Current status of the game session.
GameSession.Builder	terminationTime(Date terminationTime)	Time stamp indicating when this data object was terminated.

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

gameSessionId

GameSession.Builder gameSessionId(String gameSessionId)

Unique identifier for the game session. A game session ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .

Parameters:

gameSessionId - Unique identifier for the game session. 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.

name

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

fleetId

GameSession.Builder fleetId(String fleetId)

Unique identifier for a fleet the game session is running on.

Parameters:

fleetId - Unique identifier for a fleet the game session is running on.

Returns:

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

creationTime

GameSession.Builder creationTime(Date creationTime)

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

terminationTime

GameSession.Builder terminationTime(Date terminationTime)

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

terminationTime - Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

currentPlayerSessionCount

GameSession.Builder currentPlayerSessionCount(Integer currentPlayerSessionCount)

Number of players currently in the game session.

Parameters:

currentPlayerSessionCount - Number of players currently in the game session.

Returns:

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

maximumPlayerSessionCount

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

status

GameSession.Builder status(String status)

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

Parameters:

status - Current status of the game session. A game session must have an ACTIVE status to have player sessions.

Returns:

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

See Also:

GameSessionStatus

status

GameSession.Builder status(GameSessionStatus status)

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

Parameters:

status - Current status of the game session. A game session must have an ACTIVE status to have player sessions.

Returns:

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

See Also:

GameSessionStatus

gameProperties

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

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

ipAddress

GameSession.Builder ipAddress(String ipAddress)

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Parameters:

ipAddress - IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Returns:

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

port

GameSession.Builder port(Integer port)

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Parameters:

port - Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Returns:

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

playerSessionCreationPolicy

GameSession.Builder playerSessionCreationPolicy(String playerSessionCreationPolicy)

Indicates whether or not the game session is accepting new players.

Parameters:

playerSessionCreationPolicy - Indicates whether or not the game session is accepting new players.

Returns:

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

See Also:

PlayerSessionCreationPolicy

playerSessionCreationPolicy

GameSession.Builder playerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)

Indicates whether or not the game session is accepting new players.

Parameters:

playerSessionCreationPolicy - Indicates whether or not the game session is accepting new players.

Returns:

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

See Also:

PlayerSessionCreationPolicy

creatorId

GameSession.Builder creatorId(String creatorId)

Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

Parameters:

creatorId - Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

Returns:

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