Interface UpdateGameSessionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateGameSessionRequest.Builder,
,UpdateGameSessionRequest> GameLiftRequest.Builder
,SdkBuilder<UpdateGameSessionRequest.Builder,
,UpdateGameSessionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateGameSessionRequest
-
Method Summary
Modifier and TypeMethodDescriptiongameProperties
(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.gameSessionId
(String gameSessionId) A unique identifier for the game session to update.maximumPlayerSessionCount
(Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.A descriptive label that is associated with a game session.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.playerSessionCreationPolicy
(String playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.playerSessionCreationPolicy
(PlayerSessionCreationPolicy playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.protectionPolicy
(String protectionPolicy) Game session protection policy to apply to this game session only.protectionPolicy
(ProtectionPolicy protectionPolicy) Game session protection policy to apply to this game session only.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
-
gameSessionId
A unique identifier for the game session to update.
- Parameters:
gameSessionId
- A unique identifier for the game session to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
name
A descriptive label that is associated with a game session. Session names do not need to be unique.
- Parameters:
name
- 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.
-
playerSessionCreationPolicy
A policy that determines whether the game session is accepting new players.
- Parameters:
playerSessionCreationPolicy
- A policy that determines whether 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
UpdateGameSessionRequest.Builder playerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.
- Parameters:
playerSessionCreationPolicy
- A policy that determines whether the game session is accepting new players.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
protectionPolicy
Game session protection policy to apply to this game session only.
-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
- Parameters:
protectionPolicy
- Game session protection policy to apply to this game session only.-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
protectionPolicy
Game session protection policy to apply to this game session only.
-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
- Parameters:
protectionPolicy
- Game session protection policy to apply to this game session only.-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
gameProperties
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.- Parameters:
gameProperties
- A set of key-value pairs that can store custom data in a game session. For example:{"Key": "difficulty", "Value": "novice"}
. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.- 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"}
. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.- Parameters:
gameProperties
- A set of key-value pairs that can store custom data in a game session. For example:{"Key": "difficulty", "Value": "novice"}
. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.- 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:
This is a convenience method that creates an instance of the{"Key": "difficulty", "Value": "novice"}
. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.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:
-
overrideConfiguration
UpdateGameSessionRequest.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
UpdateGameSessionRequest.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.
-