All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartGameSessionPlacementRequest
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
  StartGameSessionPlacementRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StartGameSessionPlacementRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  List<DesiredPlayerSession>	getDesiredPlayerSessions () Set of information on each player to create a player session for.
  List<GameProperty>	getGameProperties () A set of key-value pairs that can store custom data in a game session.
  String	getGameSessionData () A set of custom game session properties, formatted as a single string value.
  String	getGameSessionName () A descriptive label that is associated with a game session.
  String	getGameSessionQueueName () Name of the queue to use to place the new game session.
  Integer	getMaximumPlayerSessionCount () The maximum number of players that can be connected simultaneously to the game session.
  String	getPlacementId () A unique identifier to assign to the new game session placement.
  List<PlayerLatency>	getPlayerLatencies () A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
  int	hashCode ()
  void	setDesiredPlayerSessions (Collection<DesiredPlayerSession> desiredPlayerSessions) Set of information on each player to create a player session for.
  void	setGameProperties (Collection<GameProperty> gameProperties) A set of key-value pairs that can store custom data in a game session.
  void	setGameSessionData (String gameSessionData) A set of custom game session properties, formatted as a single string value.
  void	setGameSessionName (String gameSessionName) A descriptive label that is associated with a game session.
  void	setGameSessionQueueName (String gameSessionQueueName) Name of the queue to use to place the new game session.
  void	setMaximumPlayerSessionCount (Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.
  void	setPlacementId (String placementId) A unique identifier to assign to the new game session placement.
  void	setPlayerLatencies (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.
  String	toString () Returns a string representation of this object.
  StartGameSessionPlacementRequest	withDesiredPlayerSessions (Collection<DesiredPlayerSession> desiredPlayerSessions) Set of information on each player to create a player session for.
  StartGameSessionPlacementRequest	withDesiredPlayerSessions (DesiredPlayerSession... desiredPlayerSessions) Set of information on each player to create a player session for.
  StartGameSessionPlacementRequest	withGameProperties (Collection<GameProperty> gameProperties) A set of key-value pairs that can store custom data in a game session.
  StartGameSessionPlacementRequest	withGameProperties (GameProperty... gameProperties) A set of key-value pairs that can store custom data in a game session.
  StartGameSessionPlacementRequest	withGameSessionData (String gameSessionData) A set of custom game session properties, formatted as a single string value.
  StartGameSessionPlacementRequest	withGameSessionName (String gameSessionName) A descriptive label that is associated with a game session.
  StartGameSessionPlacementRequest	withGameSessionQueueName (String gameSessionQueueName) Name of the queue to use to place the new game session.
  StartGameSessionPlacementRequest	withMaximumPlayerSessionCount (Integer maximumPlayerSessionCount) The maximum number of players that can be connected simultaneously to the game session.
  StartGameSessionPlacementRequest	withPlacementId (String placementId) A unique identifier to assign to the new game session placement.
  StartGameSessionPlacementRequest	withPlayerLatencies (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.
  StartGameSessionPlacementRequest	withPlayerLatencies (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 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

  • StartGameSessionPlacementRequest

    public StartGameSessionPlacementRequest()

• Method Detail

  • setPlacementId

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

  • getPlacementId

    public String getPlacementId()

    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:

    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.

  • withPlacementId

    public StartGameSessionPlacementRequest withPlacementId(String 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.

  • setGameSessionQueueName

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

  • getGameSessionQueueName

    public String getGameSessionQueueName()

    Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

    Returns:

    Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

  • withGameSessionQueueName

    public StartGameSessionPlacementRequest withGameSessionQueueName(String 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.

  • 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"}.

    Returns:

    A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

  • 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"}.

    Parameters:

    gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

  • withGameProperties

    public StartGameSessionPlacementRequest withGameProperties(GameProperty... gameProperties)

    A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

    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"}.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withGameProperties

    public StartGameSessionPlacementRequest 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"}.

    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.

  • 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 StartGameSessionPlacementRequest 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.

  • setGameSessionName

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

  • getGameSessionName

    public String getGameSessionName()

    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.

  • withGameSessionName

    public StartGameSessionPlacementRequest withGameSessionName(String 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.

  • getPlayerLatencies

    public List<PlayerLatency> getPlayerLatencies()

    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:

    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.

  • setPlayerLatencies

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

  • withPlayerLatencies

    public StartGameSessionPlacementRequest withPlayerLatencies(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. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

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

    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.

  • withPlayerLatencies

    public StartGameSessionPlacementRequest withPlayerLatencies(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. 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.

  • getDesiredPlayerSessions

    public List<DesiredPlayerSession> getDesiredPlayerSessions()

    Set of information on each player to create a player session for.

    Returns:

    Set of information on each player to create a player session for.

  • setDesiredPlayerSessions

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

  • withDesiredPlayerSessions

    public StartGameSessionPlacementRequest withDesiredPlayerSessions(DesiredPlayerSession... desiredPlayerSessions)

    Set of information on each player to create a player session for.

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

    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.

  • withDesiredPlayerSessions

    public StartGameSessionPlacementRequest withDesiredPlayerSessions(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.

  • setGameSessionData

    public void setGameSessionData(String 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 the GameSession object with a request to start a new game session (see Start a Game Session).

  • getGameSessionData

    public String getGameSessionData()

    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).

    Returns:

    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).

  • withGameSessionData

    public StartGameSessionPlacementRequest withGameSessionData(String 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 the GameSession 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.

  • 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 StartGameSessionPlacementRequest 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()