software.amazon.awssdk.services.gamelift.model

Interface StartGameSessionPlacementRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>, GameLiftRequest.Builder, SdkBuilder<StartGameSessionPlacementRequest.Builder,StartGameSessionPlacementRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartGameSessionPlacementRequest

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

Method Summary

Modifier and Type	Method and Description
StartGameSessionPlacementRequest.Builder	desiredPlayerSessions(Collection<DesiredPlayerSession> desiredPlayerSessions) Set of information on each player to create a player session for.
StartGameSessionPlacementRequest.Builder	desiredPlayerSessions(Consumer<DesiredPlayerSession.Builder>... 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) A set of custom properties for a game session, formatted as key:value pairs.
StartGameSessionPlacementRequest.Builder	gameProperties(Consumer<GameProperty.Builder>... gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
StartGameSessionPlacementRequest.Builder	gameProperties(GameProperty... gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
StartGameSessionPlacementRequest.Builder	gameSessionData(String gameSessionData) A set of custom game session properties, formatted as a single string value.
StartGameSessionPlacementRequest.Builder	gameSessionName(String gameSessionName) A 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) The maximum number of players that can be connected simultaneously to the game session.
StartGameSessionPlacementRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartGameSessionPlacementRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartGameSessionPlacementRequest.Builder	placementId(String placementId) A unique identifier to assign to the new game session placement.
StartGameSessionPlacementRequest.Builder	playerLatencies(Collection<PlayerLatency> playerLatencies) A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
StartGameSessionPlacementRequest.Builder	playerLatencies(Consumer<PlayerLatency.Builder>... playerLatencies) A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
StartGameSessionPlacementRequest.Builder	playerLatencies(PlayerLatency... playerLatencies) A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

placementId

StartGameSessionPlacementRequest.Builder placementId(String placementId)

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

Parameters:

placementId - A 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.

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. You can use either the queue name or ARN value.

Parameters:

gameSessionQueueName - Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

Returns:

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

gameProperties

StartGameSessionPlacementRequest.Builder gameProperties(Collection<GameProperty> gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

Parameters:

gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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.

gameProperties

StartGameSessionPlacementRequest.Builder gameProperties(GameProperty... gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

Parameters:

gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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.

gameProperties

StartGameSessionPlacementRequest.Builder gameProperties(Consumer<GameProperty.Builder>... gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).

This is a convenience method that creates an instance of the GameProperty.Builder avoiding the need to create one manually via GameProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #gameProperties(List).

Parameters:

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

Returns:

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

See Also:

#gameProperties(java.util.Collection)

maximumPlayerSessionCount

StartGameSessionPlacementRequest.Builder maximumPlayerSessionCount(Integer maximumPlayerSessionCount)

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

Parameters:

maximumPlayerSessionCount - The 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)

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

Parameters:

gameSessionName - A 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)

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services 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 - A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services 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)

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services 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 - A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services 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(Consumer<PlayerLatency.Builder>... playerLatencies)

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services 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.

This is a convenience method that creates an instance of the PlayerLatency.Builder avoiding the need to create one manually via PlayerLatency.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #playerLatencies(List).

Parameters:

playerLatencies - a consumer that will call methods on PlayerLatency.Builder

Returns:

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

See Also:

#playerLatencies(java.util.Collection)

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.

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(Consumer<DesiredPlayerSession.Builder>... desiredPlayerSessions)

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

This is a convenience method that creates an instance of the DesiredPlayerSession.Builder avoiding the need to create one manually via DesiredPlayerSession.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #desiredPlayerSessions(List).

Parameters:

desiredPlayerSessions - a consumer that will call methods on DesiredPlayerSession.Builder

Returns:

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

See Also:

#desiredPlayerSessions(java.util.Collection)

gameSessionData

StartGameSessionPlacementRequest.Builder gameSessionData(String gameSessionData)

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

overrideConfiguration

StartGameSessionPlacementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartGameSessionPlacementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder