com.amazonaws.services.gamelift.model

Class UpdateGameSessionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.UpdateGameSessionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateGameSessionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateGameSessionRequest()

Method Summary

Modifier and Type	Method and Description
UpdateGameSessionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<GameProperty>	getGameProperties() A set of key-value pairs that can store custom data in a game session.
String	getGameSessionId() A unique identifier for the game session to update.
Integer	getMaximumPlayerSessionCount() The maximum number of players that can be connected simultaneously to the game session.
String	getName() A descriptive label that is associated with a game session.
String	getPlayerSessionCreationPolicy() A policy that determines whether the game session is accepting new players.
String	getProtectionPolicy() Game session protection policy to apply to this game session only.
int	hashCode()
void	setGameProperties(Collection<GameProperty> gameProperties) A set of key-value pairs that can store custom data in a game session.
void	setGameSessionId(String gameSessionId) A unique identifier for the game session to update.
void	setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.
void	setName(String name) A descriptive label that is associated with a game session.
void	setPlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.
void	setPlayerSessionCreationPolicy(String playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.
void	setProtectionPolicy(ProtectionPolicy protectionPolicy) Game session protection policy to apply to this game session only.
void	setProtectionPolicy(String protectionPolicy) Game session protection policy to apply to this game session only.
String	toString() Returns a string representation of this object.
UpdateGameSessionRequest	withGameProperties(Collection<GameProperty> gameProperties) A set of key-value pairs that can store custom data in a game session.
UpdateGameSessionRequest	withGameProperties(GameProperty... gameProperties) A set of key-value pairs that can store custom data in a game session.
UpdateGameSessionRequest	withGameSessionId(String gameSessionId) A unique identifier for the game session to update.
UpdateGameSessionRequest	withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.
UpdateGameSessionRequest	withName(String name) A descriptive label that is associated with a game session.
UpdateGameSessionRequest	withPlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.
UpdateGameSessionRequest	withPlayerSessionCreationPolicy(String playerSessionCreationPolicy) A policy that determines whether the game session is accepting new players.
UpdateGameSessionRequest	withProtectionPolicy(ProtectionPolicy protectionPolicy) Game session protection policy to apply to this game session only.
UpdateGameSessionRequest	withProtectionPolicy(String protectionPolicy) Game session protection policy to apply to this game session only.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateGameSessionRequest

public UpdateGameSessionRequest()

Method Detail

setGameSessionId

public void setGameSessionId(String gameSessionId)

A unique identifier for the game session to update.

Parameters:

gameSessionId - A unique identifier for the game session to update.

getGameSessionId

public String getGameSessionId()

A unique identifier for the game session to update.

Returns:

A unique identifier for the game session to update.

withGameSessionId

public UpdateGameSessionRequest withGameSessionId(String 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.

setMaximumPlayerSessionCount

public void setMaximumPlayerSessionCount(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.

getMaximumPlayerSessionCount

public Integer getMaximumPlayerSessionCount()

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.

withMaximumPlayerSessionCount

public UpdateGameSessionRequest withMaximumPlayerSessionCount(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.

setName

public void setName(String 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.

getName

public String getName()

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.

withName

public UpdateGameSessionRequest withName(String 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.

setPlayerSessionCreationPolicy

public void setPlayerSessionCreationPolicy(String 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.

See Also:

PlayerSessionCreationPolicy

getPlayerSessionCreationPolicy

public String getPlayerSessionCreationPolicy()

A policy that determines whether the game session is accepting new players.

Returns:

A policy that determines whether the game session is accepting new players.

See Also:

PlayerSessionCreationPolicy

withPlayerSessionCreationPolicy

public UpdateGameSessionRequest withPlayerSessionCreationPolicy(String 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

setPlayerSessionCreationPolicy

public void setPlayerSessionCreationPolicy(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.

See Also:

PlayerSessionCreationPolicy

withPlayerSessionCreationPolicy

public UpdateGameSessionRequest withPlayerSessionCreationPolicy(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:

PlayerSessionCreationPolicy

setProtectionPolicy

public void setProtectionPolicy(String 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.

See Also:

ProtectionPolicy

getProtectionPolicy

public String getProtectionPolicy()

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:

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

withProtectionPolicy

public UpdateGameSessionRequest withProtectionPolicy(String 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

setProtectionPolicy

public void setProtectionPolicy(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.

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.

See Also:

ProtectionPolicy

withProtectionPolicy

public UpdateGameSessionRequest withProtectionPolicy(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.

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

getGameProperties

public List<GameProperty> getGameProperties()

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:

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.

setGameProperties

public void setGameProperties(Collection<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.

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.

withGameProperties

public UpdateGameSessionRequest withGameProperties(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.

NOTE: This method appends the values to the existing list (if any). Use setGameProperties(java.util.Collection) or withGameProperties(java.util.Collection) if you want to override the existing values.

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.

withGameProperties

public UpdateGameSessionRequest withGameProperties(Collection<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.

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateGameSessionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()