GameSessionPlacement (AWS Java SDK for AWS GameLift 1.11.106 API)

java.lang.Object
- com.amazonaws.services.gamelift.model.GameSessionPlacement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameSessionPlacement
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GameSessionPlacement()

Constructors
Constructor and Description
`GameSessionPlacement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GameSessionPlacement`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getEndTime()` Time stamp indicating when this request was completed, cancelled, or timed out.
`List<GameProperty>`	`getGameProperties()` Set of developer-defined properties for a game session.
`String`	`getGameSessionArn()` Identifier for the game session created by this placement request.
`String`	`getGameSessionName()` Descriptive label that is associated with a game session.
`String`	`getGameSessionQueueName()` Descriptive label that is associated with queue.
`String`	`getGameSessionRegion()` Name of the region where the game session created by this placement request is running.
`Integer`	`getMaximumPlayerSessionCount()` Maximum number of players that can be connected simultaneously to the game session.
`String`	`getPlacementId()` Unique identifier for a game session placement.
`List<PlayerLatency>`	`getPlayerLatencies()` Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
`Date`	`getStartTime()` Time stamp indicating when this request was placed in the queue.
`String`	`getStatus()` Current status of the game session placement request.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setEndTime(Date endTime)` Time stamp indicating when this request was completed, cancelled, or timed out.
`void`	`setGameProperties(Collection<GameProperty> gameProperties)` Set of developer-defined properties for a game session.
`void`	`setGameSessionArn(String gameSessionArn)` Identifier for the game session created by this placement request.
`void`	`setGameSessionName(String gameSessionName)` Descriptive label that is associated with a game session.
`void`	`setGameSessionQueueName(String gameSessionQueueName)` Descriptive label that is associated with queue.
`void`	`setGameSessionRegion(String gameSessionRegion)` Name of the region where the game session created by this placement request is running.
`void`	`setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` Maximum number of players that can be connected simultaneously to the game session.
`void`	`setPlacementId(String placementId)` Unique identifier for a game session placement.
`void`	`setPlayerLatencies(Collection<PlayerLatency> playerLatencies)` Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
`void`	`setStartTime(Date startTime)` Time stamp indicating when this request was placed in the queue.
`void`	`setStatus(GameSessionPlacementState status)` Current status of the game session placement request.
`void`	`setStatus(String status)` Current status of the game session placement request.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GameSessionPlacement`	`withEndTime(Date endTime)` Time stamp indicating when this request was completed, cancelled, or timed out.
`GameSessionPlacement`	`withGameProperties(Collection<GameProperty> gameProperties)` Set of developer-defined properties for a game session.
`GameSessionPlacement`	`withGameProperties(GameProperty... gameProperties)` Set of developer-defined properties for a game session.
`GameSessionPlacement`	`withGameSessionArn(String gameSessionArn)` Identifier for the game session created by this placement request.
`GameSessionPlacement`	`withGameSessionName(String gameSessionName)` Descriptive label that is associated with a game session.
`GameSessionPlacement`	`withGameSessionQueueName(String gameSessionQueueName)` Descriptive label that is associated with queue.
`GameSessionPlacement`	`withGameSessionRegion(String gameSessionRegion)` Name of the region where the game session created by this placement request is running.
`GameSessionPlacement`	`withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` Maximum number of players that can be connected simultaneously to the game session.
`GameSessionPlacement`	`withPlacementId(String placementId)` Unique identifier for a game session placement.
`GameSessionPlacement`	`withPlayerLatencies(Collection<PlayerLatency> playerLatencies)` Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
`GameSessionPlacement`	`withPlayerLatencies(PlayerLatency... playerLatencies)` Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
`GameSessionPlacement`	`withStartTime(Date startTime)` Time stamp indicating when this request was placed in the queue.
`GameSessionPlacement`	`withStatus(GameSessionPlacementState status)` Current status of the game session placement request.
`GameSessionPlacement`	`withStatus(String status)` Current status of the game session placement request.

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

- Constructor Detail
  - GameSessionPlacement
```
public GameSessionPlacement()
```
- Method Detail
  - setPlacementId
```
public void setPlacementId(String placementId)
```
    Unique identifier for a game session placement.
    
    Parameters:
    
    placementId - Unique identifier for a game session placement.
  - getPlacementId
```
public String getPlacementId()
```
    Unique identifier for a game session placement.
    
    Returns:
    
    Unique identifier for a game session placement.
  - withPlacementId
```
public GameSessionPlacement withPlacementId(String placementId)
```
    Unique identifier for a game session placement.
    
    Parameters:
    
    placementId - Unique identifier for a game session placement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGameSessionQueueName
```
public void setGameSessionQueueName(String gameSessionQueueName)
```
    Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Parameters:
    
    gameSessionQueueName - Descriptive label that is associated with queue. Queue names must be unique within each region.
  - getGameSessionQueueName
```
public String getGameSessionQueueName()
```
    Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Returns:
    
    Descriptive label that is associated with queue. Queue names must be unique within each region.
  - withGameSessionQueueName
```
public GameSessionPlacement withGameSessionQueueName(String gameSessionQueueName)
```
    Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Parameters:
    
    gameSessionQueueName - Descriptive label that is associated with queue. Queue names must be unique within each region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Current status of the game session placement request.
    - PENDING – The placement request is currently in the queue waiting to be processed.
    - FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    - CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    - TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Parameters:
    status - Current status of the game session placement request.
    
    PENDING – The placement request is currently in the queue waiting to be processed.
    
    FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    
    CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    
    TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    See Also:
    
    GameSessionPlacementState
  - getStatus
```
public String getStatus()
```
    Current status of the game session placement request.
    - PENDING – The placement request is currently in the queue waiting to be processed.
    - FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    - CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    - TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Returns:
    Current status of the game session placement request.
    
    PENDING – The placement request is currently in the queue waiting to be processed.
    
    FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    
    CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    
    TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    See Also:
    
    GameSessionPlacementState
  - withStatus
```
public GameSessionPlacement withStatus(String status)
```
    Current status of the game session placement request.
    - PENDING – The placement request is currently in the queue waiting to be processed.
    - FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    - CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    - TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Parameters:
    status - Current status of the game session placement request.
    
    PENDING – The placement request is currently in the queue waiting to be processed.
    
    FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    
    CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    
    TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionPlacementState
  - setStatus
```
public void setStatus(GameSessionPlacementState status)
```
    Current status of the game session placement request.
    - PENDING – The placement request is currently in the queue waiting to be processed.
    - FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    - CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    - TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Parameters:
    status - Current status of the game session placement request.
    
    PENDING – The placement request is currently in the queue waiting to be processed.
    
    FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    
    CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    
    TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    See Also:
    
    GameSessionPlacementState
  - withStatus
```
public GameSessionPlacement withStatus(GameSessionPlacementState status)
```
    Current status of the game session placement request.
    - PENDING – The placement request is currently in the queue waiting to be processed.
    - FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    - CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    - TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Parameters:
    status - Current status of the game session placement request.
    
    PENDING – The placement request is currently in the queue waiting to be processed.
    
    FULFILLED – A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
    
    CANCELLED – The placement request was cancelled with a call to StopGameSessionPlacement.
    
    TIMED_OUT – A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionPlacementState
  - getGameProperties
```
public List<GameProperty> getGameProperties()
```
    Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
    
    Returns:
    
    Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
  - setGameProperties
```
public void setGameProperties(Collection<GameProperty> gameProperties)
```
    Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
    
    Parameters:
    
    gameProperties - Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
  - withGameProperties
```
public GameSessionPlacement withGameProperties(GameProperty... gameProperties)
```
    Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
    
    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 - Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGameProperties
```
public GameSessionPlacement withGameProperties(Collection<GameProperty> gameProperties)
```
    Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
    
    Parameters:
    
    gameProperties - Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumPlayerSessionCount
```
public void setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)
```
    Maximum number of players that can be connected simultaneously to the game session.
    
    Parameters:
    
    maximumPlayerSessionCount - Maximum number of players that can be connected simultaneously to the game session.
  - getMaximumPlayerSessionCount
```
public Integer getMaximumPlayerSessionCount()
```
    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.
  - withMaximumPlayerSessionCount
```
public GameSessionPlacement withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)
```
    Maximum number of players that can be connected simultaneously to the game session.
    
    Parameters:
    
    maximumPlayerSessionCount - 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)
```
    Descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    gameSessionName - Descriptive label that is associated with a game session. Session names do not need to be unique.
  - getGameSessionName
```
public String getGameSessionName()
```
    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.
  - withGameSessionName
```
public GameSessionPlacement withGameSessionName(String gameSessionName)
```
    Descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    gameSessionName - 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.
  - setGameSessionArn
```
public void setGameSessionArn(String gameSessionArn)
```
    Identifier for the game session created by this placement request. This value exists only if the game session placement status is Completed. This identifier is unique across all regions.
    
    Parameters:
    
    gameSessionArn - Identifier for the game session created by this placement request. This value exists only if the game session placement status is Completed. This identifier is unique across all regions.
  - getGameSessionArn
```
public String getGameSessionArn()
```
    Identifier for the game session created by this placement request. This value exists only if the game session placement status is Completed. This identifier is unique across all regions.
    
    Returns:
    
    Identifier for the game session created by this placement request. This value exists only if the game session placement status is Completed. This identifier is unique across all regions.
  - withGameSessionArn
```
public GameSessionPlacement withGameSessionArn(String gameSessionArn)
```
    Identifier for the game session created by this placement request. This value exists only if the game session placement status is Completed. This identifier is unique across all regions.
    
    Parameters:
    
    gameSessionArn - Identifier for the game session created by this placement request. This value exists only if the game session placement status is Completed. This identifier is unique across all regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGameSessionRegion
```
public void setGameSessionRegion(String gameSessionRegion)
```
    Name of the region where the game session created by this placement request is running. This value exists only if the game session placement status is Completed.
    
    Parameters:
    
    gameSessionRegion - Name of the region where the game session created by this placement request is running. This value exists only if the game session placement status is Completed.
  - getGameSessionRegion
```
public String getGameSessionRegion()
```
    Name of the region where the game session created by this placement request is running. This value exists only if the game session placement status is Completed.
    
    Returns:
    
    Name of the region where the game session created by this placement request is running. This value exists only if the game session placement status is Completed.
  - withGameSessionRegion
```
public GameSessionPlacement withGameSessionRegion(String gameSessionRegion)
```
    Name of the region where the game session created by this placement request is running. This value exists only if the game session placement status is Completed.
    
    Parameters:
    
    gameSessionRegion - Name of the region where the game session created by this placement request is running. This value exists only if the game session placement status is Completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlayerLatencies
```
public List<PlayerLatency> getPlayerLatencies()
```
    Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
    
    Returns:
    
    Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
  - setPlayerLatencies
```
public void setPlayerLatencies(Collection<PlayerLatency> playerLatencies)
```
    Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
    
    Parameters:
    
    playerLatencies - Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
  - withPlayerLatencies
```
public GameSessionPlacement withPlayerLatencies(PlayerLatency... playerLatencies)
```
    Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
    
    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 - Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPlayerLatencies
```
public GameSessionPlacement withPlayerLatencies(Collection<PlayerLatency> playerLatencies)
```
    Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
    
    Parameters:
    
    playerLatencies - Set of values, expressed in milliseconds, indicating the amount of latency that players experience when connected to AWS regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    startTime - Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - getStartTime
```
public Date getStartTime()
```
    Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - withStartTime
```
public GameSessionPlacement withStartTime(Date startTime)
```
    Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    startTime - Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    Time stamp indicating when this request was completed, cancelled, or timed out.
    
    Parameters:
    
    endTime - Time stamp indicating when this request was completed, cancelled, or timed out.
  - getEndTime
```
public Date getEndTime()
```
    Time stamp indicating when this request was completed, cancelled, or timed out.
    
    Returns:
    
    Time stamp indicating when this request was completed, cancelled, or timed out.
  - withEndTime
```
public GameSessionPlacement withEndTime(Date endTime)
```
    Time stamp indicating when this request was completed, cancelled, or timed out.
    
    Parameters:
    
    endTime - Time stamp indicating when this request was completed, cancelled, or timed out.
    
    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; useful for testing and debugging.
    
    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 GameSessionPlacement clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class GameSessionPlacement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameSessionPlacement

Method Detail

setPlacementId

getPlacementId

withPlacementId

setGameSessionQueueName

getGameSessionQueueName

withGameSessionQueueName

setStatus

getStatus

withStatus

setStatus

withStatus

getGameProperties

setGameProperties

withGameProperties

withGameProperties

setMaximumPlayerSessionCount

getMaximumPlayerSessionCount

withMaximumPlayerSessionCount

setGameSessionName

getGameSessionName

withGameSessionName

setGameSessionArn

getGameSessionArn

withGameSessionArn

setGameSessionRegion

getGameSessionRegion

withGameSessionRegion

getPlayerLatencies

setPlayerLatencies

withPlayerLatencies

withPlayerLatencies

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

toString

equals

hashCode

clone

marshall