software.amazon.awssdk.services.gamelift.model

Interface GameSession.Builder

All Superinterfaces:

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

Enclosing class:

GameSession

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

Method Summary

Modifier and Type	Method and Description
GameSession.Builder	creationTime(Instant 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 that the game session is running on.
GameSession.Builder	gameProperties(Collection<GameProperty> gameProperties) Set of custom properties for a game session, formatted as key:value pairs.
GameSession.Builder	gameProperties(Consumer<GameProperty.Builder>... gameProperties) Set of custom properties for a game session, formatted as key:value pairs.
GameSession.Builder	gameProperties(GameProperty... gameProperties) Set of custom properties for a game session, formatted as key:value pairs.
GameSession.Builder	gameSessionData(String gameSessionData) Set of custom game session properties, formatted as a single string value.
GameSession.Builder	gameSessionId(String gameSessionId) Unique identifier for the game session.
GameSession.Builder	ipAddress(String ipAddress) IP address of the game session.
GameSession.Builder	matchmakerData(String matchmakerData) Information about the matchmaking process that was used to create 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(PlayerSessionCreationPolicy playerSessionCreationPolicy) Indicates whether or not the game session is accepting new players.
GameSession.Builder	playerSessionCreationPolicy(String 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(GameSessionStatus status) Current status of the game session.
GameSession.Builder	status(String status) Current status of the game session.
GameSession.Builder	statusReason(GameSessionStatusReason statusReason) Provides additional information about game session status.
GameSession.Builder	statusReason(String statusReason) Provides additional information about game session status.
GameSession.Builder	terminationTime(Instant terminationTime) Time stamp indicating when this data object was terminated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

gameSessionId

GameSession.Builder gameSessionId(String gameSessionId)

Unique identifier for the game session. A game session ARN 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 ARN 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 that the game session is running on.

Parameters:

fleetId - Unique identifier for a fleet that 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(Instant 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(Instant 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, 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, GameSessionStatus

statusReason

GameSession.Builder statusReason(String statusReason)

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

Parameters:

statusReason - Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

Returns:

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

See Also:

GameSessionStatusReason, GameSessionStatusReason

statusReason

GameSession.Builder statusReason(GameSessionStatusReason statusReason)

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

Parameters:

statusReason - Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

Returns:

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

See Also:

GameSessionStatusReason, GameSessionStatusReason

gameProperties

GameSession.Builder gameProperties(Collection<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). You can search for active game sessions based on this custom data with SearchGameSessions.

Parameters:

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). You can search for active game sessions based on this custom data with SearchGameSessions.

Returns:

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

gameProperties

GameSession.Builder gameProperties(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). You can search for active game sessions based on this custom data with SearchGameSessions.

Parameters:

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). You can search for active game sessions based on this custom data with SearchGameSessions.

Returns:

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

gameProperties

GameSession.Builder gameProperties(Consumer<GameProperty.Builder>... 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). You can search for active game sessions based on this custom data with SearchGameSessions.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #gameProperties(List).

Parameters:

gameProperties - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#gameProperties(List)

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

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

gameSessionData

GameSession.Builder gameSessionData(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).

Parameters:

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:

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

matchmakerData

GameSession.Builder matchmakerData(String matchmakerData)

Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

Parameters:

matchmakerData - Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

Returns:

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