GameSessionPlacement (AWS SDK for Java

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)`
`String`	`getDnsName()` The DNS identifier assigned to the instance that is running the game session.
`Date`	`getEndTime()` Time stamp indicating when this request was completed, canceled, or timed out.
`List<GameProperty>`	`getGameProperties()` A set of custom properties for a game session, formatted as key:value pairs.
`String`	`getGameSessionArn()` Identifier for the game session created by this placement request.
`String`	`getGameSessionData()` A set of custom game session properties, formatted as a single string value.
`String`	`getGameSessionId()` A unique identifier for the game session.
`String`	`getGameSessionName()` A descriptive label that is associated with a game session.
`String`	`getGameSessionQueueName()` A descriptive label that is associated with game session queue.
`String`	`getGameSessionRegion()` Name of the Region where the game session created by this placement request is running.
`String`	`getIpAddress()` The IP address of the game session.
`String`	`getMatchmakerData()` Information on the matchmaking process for this game.
`Integer`	`getMaximumPlayerSessionCount()` The maximum number of players that can be connected simultaneously to the game session.
`List<PlacedPlayerSession>`	`getPlacedPlayerSessions()` A collection of information on player sessions created in response to the game session placement request.
`String`	`getPlacementId()` A unique identifier for a 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 AWS Regions.
`Integer`	`getPort()` The port number for the game session.
`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)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDnsName(String dnsName)` The DNS identifier assigned to the instance that is running the game session.
`void`	`setEndTime(Date endTime)` Time stamp indicating when this request was completed, canceled, or timed out.
`void`	`setGameProperties(Collection<GameProperty> gameProperties)` A set of custom properties for a game session, formatted as key:value pairs.
`void`	`setGameSessionArn(String gameSessionArn)` Identifier for the game session created by this placement request.
`void`	`setGameSessionData(String gameSessionData)` A set of custom game session properties, formatted as a single string value.
`void`	`setGameSessionId(String gameSessionId)` A unique identifier for the game session.
`void`	`setGameSessionName(String gameSessionName)` A descriptive label that is associated with a game session.
`void`	`setGameSessionQueueName(String gameSessionQueueName)` A descriptive label that is associated with game session queue.
`void`	`setGameSessionRegion(String gameSessionRegion)` Name of the Region where the game session created by this placement request is running.
`void`	`setIpAddress(String ipAddress)` The IP address of the game session.
`void`	`setMatchmakerData(String matchmakerData)` Information on the matchmaking process for this game.
`void`	`setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` The maximum number of players that can be connected simultaneously to the game session.
`void`	`setPlacedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions)` A collection of information on player sessions created in response to the game session placement request.
`void`	`setPlacementId(String placementId)` A unique identifier for a 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 AWS Regions.
`void`	`setPort(Integer port)` The port number for the game session.
`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.
`GameSessionPlacement`	`withDnsName(String dnsName)` The DNS identifier assigned to the instance that is running the game session.
`GameSessionPlacement`	`withEndTime(Date endTime)` Time stamp indicating when this request was completed, canceled, or timed out.
`GameSessionPlacement`	`withGameProperties(Collection<GameProperty> gameProperties)` A set of custom properties for a game session, formatted as key:value pairs.
`GameSessionPlacement`	`withGameProperties(GameProperty... gameProperties)` A set of custom properties for a game session, formatted as key:value pairs.
`GameSessionPlacement`	`withGameSessionArn(String gameSessionArn)` Identifier for the game session created by this placement request.
`GameSessionPlacement`	`withGameSessionData(String gameSessionData)` A set of custom game session properties, formatted as a single string value.
`GameSessionPlacement`	`withGameSessionId(String gameSessionId)` A unique identifier for the game session.
`GameSessionPlacement`	`withGameSessionName(String gameSessionName)` A descriptive label that is associated with a game session.
`GameSessionPlacement`	`withGameSessionQueueName(String gameSessionQueueName)` A descriptive label that is associated with game session queue.
`GameSessionPlacement`	`withGameSessionRegion(String gameSessionRegion)` Name of the Region where the game session created by this placement request is running.
`GameSessionPlacement`	`withIpAddress(String ipAddress)` The IP address of the game session.
`GameSessionPlacement`	`withMatchmakerData(String matchmakerData)` Information on the matchmaking process for this game.
`GameSessionPlacement`	`withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` The maximum number of players that can be connected simultaneously to the game session.
`GameSessionPlacement`	`withPlacedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions)` A collection of information on player sessions created in response to the game session placement request.
`GameSessionPlacement`	`withPlacedPlayerSessions(PlacedPlayerSession... placedPlayerSessions)` A collection of information on player sessions created in response to the game session placement request.
`GameSessionPlacement`	`withPlacementId(String placementId)` A unique identifier for a game session placement.
`GameSessionPlacement`	`withPlayerLatencies(Collection<PlayerLatency> playerLatencies)` A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.
`GameSessionPlacement`	`withPlayerLatencies(PlayerLatency... playerLatencies)` A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.
`GameSessionPlacement`	`withPort(Integer port)` The port number for the game session.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GameSessionPlacement
```
public GameSessionPlacement()
```
- Method Detail
  - setPlacementId
```
public void setPlacementId(String placementId)
```
    A unique identifier for a game session placement.
    
    Parameters:
    
    placementId - A unique identifier for a game session placement.
  - getPlacementId
```
public String getPlacementId()
```
    A unique identifier for a game session placement.
    
    Returns:
    
    A unique identifier for a game session placement.
  - withPlacementId
```
public GameSessionPlacement withPlacementId(String placementId)
```
    A unique identifier for a game session placement.
    
    Parameters:
    
    placementId - A 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)
```
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Parameters:
    
    gameSessionQueueName - A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
  - getGameSessionQueueName
```
public String getGameSessionQueueName()
```
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Returns:
    
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
  - withGameSessionQueueName
```
public GameSessionPlacement withGameSessionQueueName(String gameSessionQueueName)
```
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    
    Parameters:
    
    gameSessionQueueName - A descriptive label that is associated with game session 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 canceled 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.
    - FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    
    FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    - FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    
    FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    - FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    
    FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    - FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    
    FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    - FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    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 canceled 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.
    
    FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionPlacementState
  - getGameProperties
```
public List<GameProperty> getGameProperties()
```
    A set of custom properties for a game session, formatted as key:value pairs. These properties are 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 properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
  - setGameProperties
```
public void setGameProperties(Collection<GameProperty> gameProperties)
```
    A set of custom properties for a game session, formatted as key:value pairs. These properties are 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:
    
    gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
  - withGameProperties
```
public GameSessionPlacement withGameProperties(GameProperty... gameProperties)
```
    A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a 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 - A set of custom properties for a game session, formatted as key:value pairs. These properties are 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.
  - withGameProperties
```
public GameSessionPlacement withGameProperties(Collection<GameProperty> gameProperties)
```
    A set of custom properties for a game session, formatted as key:value pairs. These properties are 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:
    
    gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are 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.
  - 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 GameSessionPlacement 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 GameSessionPlacement 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.
  - setGameSessionId
```
public void setGameSessionId(String gameSessionId)
```
    A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    gameSessionId - A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
  - getGameSessionId
```
public String getGameSessionId()
```
    A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Returns:
    
    A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
  - withGameSessionId
```
public GameSessionPlacement withGameSessionId(String gameSessionId)
```
    A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    gameSessionId - A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).
    
    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 is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
    
    Parameters:
    
    gameSessionArn - Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
  - getGameSessionArn
```
public String getGameSessionArn()
```
    Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
    
    Returns:
    
    Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
  - withGameSessionArn
```
public GameSessionPlacement withGameSessionArn(String gameSessionArn)
```
    Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
    
    Parameters:
    
    gameSessionArn - Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
    
    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 is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    gameSessionRegion - Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
  - getGameSessionRegion
```
public String getGameSessionRegion()
```
    Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Returns:
    
    Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
  - withGameSessionRegion
```
public GameSessionPlacement withGameSessionRegion(String gameSessionRegion)
```
    Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    gameSessionRegion - Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
    
    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 AWS Regions.
    
    Returns:
    
    A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.
  - 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 AWS Regions.
    
    Parameters:
    
    playerLatencies - A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.
  - withPlayerLatencies
```
public GameSessionPlacement withPlayerLatencies(PlayerLatency... playerLatencies)
```
    A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences 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 - A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences 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)
```
    A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.
    
    Parameters:
    
    playerLatencies - A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences 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, canceled, or timed out.
    
    Parameters:
    
    endTime - Time stamp indicating when this request was completed, canceled, or timed out.
  - getEndTime
```
public Date getEndTime()
```
    Time stamp indicating when this request was completed, canceled, or timed out.
    
    Returns:
    
    Time stamp indicating when this request was completed, canceled, or timed out.
  - withEndTime
```
public GameSessionPlacement withEndTime(Date endTime)
```
    Time stamp indicating when this request was completed, canceled, or timed out.
    
    Parameters:
    
    endTime - Time stamp indicating when this request was completed, canceled, or timed out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    ipAddress - The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
  - getIpAddress
```
public String getIpAddress()
```
    The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Returns:
    
    The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
  - withIpAddress
```
public GameSessionPlacement withIpAddress(String ipAddress)
```
    The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    ipAddress - The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDnsName
```
public void setDnsName(String dnsName)
```
    The DNS identifier assigned to the instance that is running the game session. Values have the following format:
    - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
    - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
    When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
    Parameters:
    dnsName - The DNS identifier assigned to the instance that is running the game session. Values have the following format:
    
    TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
    
    Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
    
    When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
  - getDnsName
```
public String getDnsName()
```
    The DNS identifier assigned to the instance that is running the game session. Values have the following format:
    - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
    - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
    When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
    Returns:
    The DNS identifier assigned to the instance that is running the game session. Values have the following format:
    
    TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
    
    Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
    
    When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
  - withDnsName
```
public GameSessionPlacement withDnsName(String dnsName)
```
    The DNS identifier assigned to the instance that is running the game session. Values have the following format:
    - TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
    - Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
    When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
    Parameters:
    dnsName - The DNS identifier assigned to the instance that is running the game session. Values have the following format:
    
    TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
    
    Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
    
    When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    port - The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
  - getPort
```
public Integer getPort()
```
    The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Returns:
    
    The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
  - withPort
```
public GameSessionPlacement withPort(Integer port)
```
    The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Parameters:
    
    port - The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlacedPlayerSessions
```
public List<PlacedPlayerSession> getPlacedPlayerSessions()
```
    A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
    
    Returns:
    
    A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
  - setPlacedPlayerSessions
```
public void setPlacedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions)
```
    A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
    
    Parameters:
    
    placedPlayerSessions - A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
  - withPlacedPlayerSessions
```
public GameSessionPlacement withPlacedPlayerSessions(PlacedPlayerSession... placedPlayerSessions)
```
    A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
    
    NOTE: This method appends the values to the existing list (if any). Use setPlacedPlayerSessions(java.util.Collection) or withPlacedPlayerSessions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    placedPlayerSessions - A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPlacedPlayerSessions
```
public GameSessionPlacement withPlacedPlayerSessions(Collection<PlacedPlayerSession> placedPlayerSessions)
```
    A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
    
    Parameters:
    
    placedPlayerSessions - A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
    
    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 GameSessionPlacement 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.
  - setMatchmakerData
```
public void setMatchmakerData(String matchmakerData)
```
    Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
    
    Parameters:
    
    matchmakerData - Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
  - getMatchmakerData
```
public String getMatchmakerData()
```
    Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
    
    Returns:
    
    Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
  - withMatchmakerData
```
public GameSessionPlacement withMatchmakerData(String matchmakerData)
```
    Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
    
    Parameters:
    
    matchmakerData - Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
    
    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 GameSessionPlacement clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

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

setGameSessionId

getGameSessionId

withGameSessionId

setGameSessionArn

getGameSessionArn

withGameSessionArn

setGameSessionRegion

getGameSessionRegion

withGameSessionRegion

getPlayerLatencies

setPlayerLatencies

withPlayerLatencies

withPlayerLatencies

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setIpAddress

getIpAddress

withIpAddress

setDnsName

getDnsName

withDnsName

setPort

getPort

withPort

getPlacedPlayerSessions

setPlacedPlayerSessions

withPlacedPlayerSessions

withPlacedPlayerSessions

setGameSessionData

getGameSessionData

withGameSessionData

setMatchmakerData

getMatchmakerData

withMatchmakerData

toString

equals

hashCode

clone

marshall