Interface StartGameSessionPlacementRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartGameSessionPlacementRequest.Builder,
,StartGameSessionPlacementRequest> GameLiftRequest.Builder
,SdkBuilder<StartGameSessionPlacementRequest.Builder,
,StartGameSessionPlacementRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartGameSessionPlacementRequest
-
Method Summary
Modifier and TypeMethodDescriptiondesiredPlayerSessions
(Collection<DesiredPlayerSession> desiredPlayerSessions) Set of information on each player to create a player session for.desiredPlayerSessions
(Consumer<DesiredPlayerSession.Builder>... desiredPlayerSessions) Set of information on each player to create a player session for.desiredPlayerSessions
(DesiredPlayerSession... desiredPlayerSessions) Set of information on each player to create a player session for.gameProperties
(Collection<GameProperty> gameProperties) A set of key-value pairs that can store custom data in a game session.gameProperties
(Consumer<GameProperty.Builder>... gameProperties) A set of key-value pairs that can store custom data in a game session.gameProperties
(GameProperty... gameProperties) A set of key-value pairs that can store custom data in a game session.gameSessionData
(String gameSessionData) A set of custom game session properties, formatted as a single string value.gameSessionName
(String gameSessionName) A descriptive label that is associated with a game session.gameSessionQueueName
(String gameSessionQueueName) Name of the queue to use to place the new game session.maximumPlayerSessionCount
(Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.placementId
(String placementId) A unique identifier to assign to the new game session placement.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.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.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.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
.- Parameters:
gameProperties
- A set of key-value pairs that can store custom data in a game session. For example:{"Key": "difficulty", "Value": "novice"}
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameProperties
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
.- Parameters:
gameProperties
- A set of key-value pairs that can store custom data in a game session. For example:{"Key": "difficulty", "Value": "novice"}
.- 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 key-value pairs that can store custom data in a game session. For example:
This is a convenience method that creates an instance of the{"Key": "difficulty", "Value": "novice"}
.GameProperty.Builder
avoiding the need to create one manually viaGameProperty.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togameProperties(List<GameProperty>)
.- Parameters:
gameProperties
- a consumer that will call methods onGameProperty.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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 thePlayerLatency.Builder
avoiding the need to create one manually viaPlayerLatency.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplayerLatencies(List<PlayerLatency>)
.- Parameters:
playerLatencies
- a consumer that will call methods onPlayerLatency.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDesiredPlayerSession.Builder
avoiding the need to create one manually viaDesiredPlayerSession.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todesiredPlayerSessions(List<DesiredPlayerSession>)
.- Parameters:
desiredPlayerSessions
- a consumer that will call methods onDesiredPlayerSession.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theGameSession
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartGameSessionPlacementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-