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

Interface StartGameSessionPlacementRequest.Builder

All Superinterfaces:

CopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>, SdkBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>

Enclosing class:

StartGameSessionPlacementRequest

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

Method Summary

Modifier and Type	Method	Description
StartGameSessionPlacementRequest.Builder	desiredPlayerSessions(Collection<DesiredPlayerSession> desiredPlayerSessions)	Set of information on each player to create a player session for.
StartGameSessionPlacementRequest.Builder	desiredPlayerSessions(DesiredPlayerSession... desiredPlayerSessions)	Set of information on each player to create a player session for.
StartGameSessionPlacementRequest.Builder	gameProperties(Collection<GameProperty> gameProperties)	Set of developer-defined properties for a game session.
StartGameSessionPlacementRequest.Builder	gameProperties(GameProperty... gameProperties)	Set of developer-defined properties for a game session.
StartGameSessionPlacementRequest.Builder	gameSessionName(String gameSessionName)	Descriptive label that is associated with a game session.
StartGameSessionPlacementRequest.Builder	gameSessionQueueName(String gameSessionQueueName)	Name of the queue to use to place the new game session.
StartGameSessionPlacementRequest.Builder	maximumPlayerSessionCount(Integer maximumPlayerSessionCount)	Maximum number of players that can be connected simultaneously to the game session.
StartGameSessionPlacementRequest.Builder	placementId(String placementId)	Unique identifier to assign to the new game session placement.
StartGameSessionPlacementRequest.Builder	playerLatencies(Collection<PlayerLatency> playerLatencies)	Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.
StartGameSessionPlacementRequest.Builder	playerLatencies(PlayerLatency... playerLatencies)	Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions.

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

placementId

StartGameSessionPlacementRequest.Builder placementId(String placementId)

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Parameters:

placementId - Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

Returns:

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

gameSessionQueueName

StartGameSessionPlacementRequest.Builder gameSessionQueueName(String gameSessionQueueName)

Name of the queue to use to place the new game session.

Parameters:

gameSessionQueueName - Name of the queue to use to place the new game session.

Returns:

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

gameProperties

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

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

maximumPlayerSessionCount

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

gameSessionName

StartGameSessionPlacementRequest.Builder gameSessionName(String gameSessionName)

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

Parameters:

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

playerLatencies

StartGameSessionPlacementRequest.Builder playerLatencies(Collection<PlayerLatency> playerLatencies)

Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Parameters:

playerLatencies - Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Returns:

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

playerLatencies

StartGameSessionPlacementRequest.Builder playerLatencies(PlayerLatency... playerLatencies)

Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

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

Parameters:

playerLatencies - Set of values, expressed in milliseconds, indicating the amount of latency that players are experiencing when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Returns:

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

desiredPlayerSessions

StartGameSessionPlacementRequest.Builder desiredPlayerSessions(Collection<DesiredPlayerSession> desiredPlayerSessions)

Set of information on each player to create a player session for.

Parameters:

desiredPlayerSessions - Set of information on each player to create a player session for.

Returns:

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

desiredPlayerSessions

StartGameSessionPlacementRequest.Builder desiredPlayerSessions(DesiredPlayerSession... desiredPlayerSessions)

Set of information on each player to create a player session for.

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

Parameters:

desiredPlayerSessions - Set of information on each player to create a player session for.

Returns:

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