java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.gamelift.model.GameLiftRequest
    - - software.amazon.awssdk.services.gamelift.model.UpdateGameSessionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateGameSessionRequest.Builder,UpdateGameSessionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateGameSessionRequest
extends GameLiftRequest
implements ToCopyableBuilder<UpdateGameSessionRequest.Builder,UpdateGameSessionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateGameSessionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateGameSessionRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<GameProperty>`	`gameProperties()`	A set of key-value pairs that can store custom data in a game session.
`String`	`gameSessionId()`	A unique identifier for the game session to update.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasGameProperties()`	For responses, this returns true if the service returned a value for the GameProperties property.
`int`	`hashCode()`
`Integer`	`maximumPlayerSessionCount()`	The maximum number of players that can be connected simultaneously to the game session.
`String`	`name()`	A descriptive label that is associated with a game session.
`PlayerSessionCreationPolicy`	`playerSessionCreationPolicy()`	A policy that determines whether the game session is accepting new players.
`String`	`playerSessionCreationPolicyAsString()`	A policy that determines whether the game session is accepting new players.
`ProtectionPolicy`	`protectionPolicy()`	Game session protection policy to apply to this game session only.
`String`	`protectionPolicyAsString()`	Game session protection policy to apply to this game session only.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateGameSessionRequest.Builder>`	`serializableBuilderClass()`
`UpdateGameSessionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - gameSessionId
```
public final String gameSessionId()
```
    A unique identifier for the game session to update.
    
    Returns:
    
    A unique identifier for the game session to update.
  - maximumPlayerSessionCount
```
public final Integer maximumPlayerSessionCount()
```
    The maximum number of players that can be connected simultaneously to the game session.
    
    Returns:
    
    The maximum number of players that can be connected simultaneously to the game session.
  - name
```
public final String name()
```
    A descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Returns:
    
    A descriptive label that is associated with a game session. Session names do not need to be unique.
  - playerSessionCreationPolicy
```
public final PlayerSessionCreationPolicy playerSessionCreationPolicy()
```
    A policy that determines whether the game session is accepting new players.
    
    If the service returns an enum value that is not available in the current SDK version, playerSessionCreationPolicy will return PlayerSessionCreationPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from playerSessionCreationPolicyAsString().
    
    Returns:
    
    A policy that determines whether the game session is accepting new players.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - playerSessionCreationPolicyAsString
```
public final String playerSessionCreationPolicyAsString()
```
    A policy that determines whether the game session is accepting new players.
    
    If the service returns an enum value that is not available in the current SDK version, playerSessionCreationPolicy will return PlayerSessionCreationPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from playerSessionCreationPolicyAsString().
    
    Returns:
    
    A policy that determines whether the game session is accepting new players.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - protectionPolicy
```
public final ProtectionPolicy 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.
    
    If the service returns an enum value that is not available in the current SDK version, protectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protectionPolicyAsString().
    Returns:
    
    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.
    
    See Also:
    
    ProtectionPolicy
  - protectionPolicyAsString
```
public final String protectionPolicyAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, protectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protectionPolicyAsString().
    Returns:
    
    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.
    
    See Also:
    
    ProtectionPolicy
  - hasGameProperties
```
public final boolean hasGameProperties()
```
    For responses, this returns true if the service returned a value for the GameProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - gameProperties
```
public final List<GameProperty> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGameProperties() method.
    
    Returns:
    
    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.
  - toBuilder
```
public UpdateGameSessionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateGameSessionRequest.Builder,UpdateGameSessionRequest>
    
    Specified by:
    
    toBuilder in class GameLiftRequest
  - builder
```
public static UpdateGameSessionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateGameSessionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateGameSessionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

gameSessionId

maximumPlayerSessionCount

name

playerSessionCreationPolicy

playerSessionCreationPolicyAsString

protectionPolicy

protectionPolicyAsString

hasGameProperties

gameProperties

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields