software.amazon.awssdk.services.gamelift.model

Class UpdateGameSessionRequest

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(value="software.amazon.awssdk:codegen")
public final class UpdateGameSessionRequest
extends GameLiftRequest
implements ToCopyableBuilder<UpdateGameSessionRequest.Builder,UpdateGameSessionRequest>

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateGameSessionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateGameSessionRequest.Builder	builder()
boolean	equals(Object obj)
String	gameSessionId() Unique identifier for the game session to update.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maximumPlayerSessionCount() Maximum number of players that can be connected simultaneously to the game session.
String	name() Descriptive label that is associated with a game session.
PlayerSessionCreationPolicy	playerSessionCreationPolicy() Policy determining whether or not the game session accepts new players.
String	playerSessionCreationPolicyAsString() Policy determining whether or not the game session accepts 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gameSessionId

public String gameSessionId()

Unique identifier for the game session to update.

Returns:

Unique identifier for the game session to update.

maximumPlayerSessionCount

public Integer maximumPlayerSessionCount()

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

Returns:

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

name

public String name()

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

Returns:

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

playerSessionCreationPolicy

public PlayerSessionCreationPolicy playerSessionCreationPolicy()

Policy determining whether or not the game session accepts 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:

Policy determining whether or not the game session accepts new players.

See Also:

PlayerSessionCreationPolicy

playerSessionCreationPolicyAsString

public String playerSessionCreationPolicyAsString()

Policy determining whether or not the game session accepts 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:

Policy determining whether or not the game session accepts new players.

See Also:

PlayerSessionCreationPolicy

protectionPolicy

public 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 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

toBuilder

public UpdateGameSessionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGameSessionRequest.Builder,UpdateGameSessionRequest>

Specified by:

toBuilder in class GameLiftRequest

Returns:

a builder for type T

builder

public static UpdateGameSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateGameSessionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.