GameSession (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameSession
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GameSession()

Constructors
Constructor and Description
`GameSession()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GameSession`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` A time stamp indicating when this data object was created.
`String`	`getCreatorId()` A unique identifier for a player.
`Integer`	`getCurrentPlayerSessionCount()` Number of players currently in the game session.
`String`	`getDnsName()` The DNS identifier assigned to the instance that is running the game session.
`String`	`getFleetArn()` The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
`String`	`getFleetId()` A unique identifier for the fleet that the game session is running on.
`List<GameProperty>`	`getGameProperties()` A set of custom properties for a game session, formatted as key:value pairs.
`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`	`getIpAddress()` The IP address of the game session.
`String`	`getLocation()` The fleet location where the game session is running.
`String`	`getMatchmakerData()` Information about the matchmaking process that was used to create the game session.
`Integer`	`getMaximumPlayerSessionCount()` The maximum number of players that can be connected simultaneously to the game session.
`String`	`getName()` A descriptive label that is associated with a game session.
`String`	`getPlayerSessionCreationPolicy()` Indicates whether or not the game session is accepting new players.
`Integer`	`getPort()` The port number for the game session.
`String`	`getStatus()` Current status of the game session.
`String`	`getStatusReason()` Provides additional information about game session status.
`Date`	`getTerminationTime()` A time stamp indicating when this data object was terminated.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` A time stamp indicating when this data object was created.
`void`	`setCreatorId(String creatorId)` A unique identifier for a player.
`void`	`setCurrentPlayerSessionCount(Integer currentPlayerSessionCount)` Number of players currently in the game session.
`void`	`setDnsName(String dnsName)` The DNS identifier assigned to the instance that is running the game session.
`void`	`setFleetArn(String fleetArn)` The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
`void`	`setFleetId(String fleetId)` A unique identifier for the fleet that the game session is running on.
`void`	`setGameProperties(Collection<GameProperty> gameProperties)` A set of custom properties for a game session, formatted as key:value pairs.
`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`	`setIpAddress(String ipAddress)` The IP address of the game session.
`void`	`setLocation(String location)` The fleet location where the game session is running.
`void`	`setMatchmakerData(String matchmakerData)` Information about the matchmaking process that was used to create the game session.
`void`	`setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` The maximum number of players that can be connected simultaneously to the game session.
`void`	`setName(String name)` A descriptive label that is associated with a game session.
`void`	`setPlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)` Indicates whether or not the game session is accepting new players.
`void`	`setPlayerSessionCreationPolicy(String playerSessionCreationPolicy)` Indicates whether or not the game session is accepting new players.
`void`	`setPort(Integer port)` The port number for the game session.
`void`	`setStatus(GameSessionStatus status)` Current status of the game session.
`void`	`setStatus(String status)` Current status of the game session.
`void`	`setStatusReason(GameSessionStatusReason statusReason)` Provides additional information about game session status.
`void`	`setStatusReason(String statusReason)` Provides additional information about game session status.
`void`	`setTerminationTime(Date terminationTime)` A time stamp indicating when this data object was terminated.
`String`	`toString()` Returns a string representation of this object.
`GameSession`	`withCreationTime(Date creationTime)` A time stamp indicating when this data object was created.
`GameSession`	`withCreatorId(String creatorId)` A unique identifier for a player.
`GameSession`	`withCurrentPlayerSessionCount(Integer currentPlayerSessionCount)` Number of players currently in the game session.
`GameSession`	`withDnsName(String dnsName)` The DNS identifier assigned to the instance that is running the game session.
`GameSession`	`withFleetArn(String fleetArn)` The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
`GameSession`	`withFleetId(String fleetId)` A unique identifier for the fleet that the game session is running on.
`GameSession`	`withGameProperties(Collection<GameProperty> gameProperties)` A set of custom properties for a game session, formatted as key:value pairs.
`GameSession`	`withGameProperties(GameProperty... gameProperties)` A set of custom properties for a game session, formatted as key:value pairs.
`GameSession`	`withGameSessionData(String gameSessionData)` A set of custom game session properties, formatted as a single string value.
`GameSession`	`withGameSessionId(String gameSessionId)` A unique identifier for the game session.
`GameSession`	`withIpAddress(String ipAddress)` The IP address of the game session.
`GameSession`	`withLocation(String location)` The fleet location where the game session is running.
`GameSession`	`withMatchmakerData(String matchmakerData)` Information about the matchmaking process that was used to create the game session.
`GameSession`	`withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` The maximum number of players that can be connected simultaneously to the game session.
`GameSession`	`withName(String name)` A descriptive label that is associated with a game session.
`GameSession`	`withPlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)` Indicates whether or not the game session is accepting new players.
`GameSession`	`withPlayerSessionCreationPolicy(String playerSessionCreationPolicy)` Indicates whether or not the game session is accepting new players.
`GameSession`	`withPort(Integer port)` The port number for the game session.
`GameSession`	`withStatus(GameSessionStatus status)` Current status of the game session.
`GameSession`	`withStatus(String status)` Current status of the game session.
`GameSession`	`withStatusReason(GameSessionStatusReason statusReason)` Provides additional information about game session status.
`GameSession`	`withStatusReason(String statusReason)` Provides additional information about game session status.
`GameSession`	`withTerminationTime(Date terminationTime)` A time stamp indicating when this data object was terminated.

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

- Constructor Detail
  - GameSession
```
public GameSession()
```
- Method Detail
  - setGameSessionId
```
public void setGameSessionId(String gameSessionId)
```
    A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
    
    Parameters:
    
    gameSessionId - A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
  - getGameSessionId
```
public String getGameSessionId()
```
    A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
    
    Returns:
    
    A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
  - withGameSessionId
```
public GameSession withGameSessionId(String gameSessionId)
```
    A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
    
    Parameters:
    
    gameSessionId - A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    name - A descriptive label that is associated with a game session. Session names do not need to be unique.
  - getName
```
public String getName()
```
    A descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Returns:
    
    A descriptive label that is associated with a game session. Session names do not need to be unique.
  - withName
```
public GameSession withName(String name)
```
    A descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    name - A descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFleetId
```
public void setFleetId(String fleetId)
```
    A unique identifier for the fleet that the game session is running on.
    
    Parameters:
    
    fleetId - A unique identifier for the fleet that the game session is running on.
  - getFleetId
```
public String getFleetId()
```
    A unique identifier for the fleet that the game session is running on.
    
    Returns:
    
    A unique identifier for the fleet that the game session is running on.
  - withFleetId
```
public GameSession withFleetId(String fleetId)
```
    A unique identifier for the fleet that the game session is running on.
    
    Parameters:
    
    fleetId - A unique identifier for the fleet that the game session is running on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFleetArn
```
public void setFleetArn(String fleetArn)
```
    The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
    
    Parameters:
    
    fleetArn - The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
  - getFleetArn
```
public String getFleetArn()
```
    The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
    
    Returns:
    
    The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
  - withFleetArn
```
public GameSession withFleetArn(String fleetArn)
```
    The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
    
    Parameters:
    
    fleetArn - The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - getCreationTime
```
public Date getCreationTime()
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - withCreationTime
```
public GameSession withCreationTime(Date creationTime)
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    creationTime - A time stamp indicating when this data object was created. 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.
  - setTerminationTime
```
public void setTerminationTime(Date terminationTime)
```
    A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    terminationTime - A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - getTerminationTime
```
public Date getTerminationTime()
```
    A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - withTerminationTime
```
public GameSession withTerminationTime(Date terminationTime)
```
    A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Parameters:
    
    terminationTime - A time stamp indicating when this data object was terminated. 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.
  - setCurrentPlayerSessionCount
```
public void setCurrentPlayerSessionCount(Integer currentPlayerSessionCount)
```
    Number of players currently in the game session.
    
    Parameters:
    
    currentPlayerSessionCount - Number of players currently in the game session.
  - getCurrentPlayerSessionCount
```
public Integer getCurrentPlayerSessionCount()
```
    Number of players currently in the game session.
    
    Returns:
    
    Number of players currently in the game session.
  - withCurrentPlayerSessionCount
```
public GameSession withCurrentPlayerSessionCount(Integer currentPlayerSessionCount)
```
    Number of players currently in the game session.
    
    Parameters:
    
    currentPlayerSessionCount - Number of players currently in the 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 GameSession 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.
  - setStatus
```
public void setStatus(String status)
```
    Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    See Also:
    
    GameSessionStatus
  - getStatus
```
public String getStatus()
```
    Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Returns:
    
    Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    See Also:
    
    GameSessionStatus
  - withStatus
```
public GameSession withStatus(String status)
```
    Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionStatus
  - setStatus
```
public void setStatus(GameSessionStatus status)
```
    Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    See Also:
    
    GameSessionStatus
  - withStatus
```
public GameSession withStatus(GameSessionStatus status)
```
    Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must have an ACTIVE status to have player sessions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Parameters:
    
    statusReason - Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    See Also:
    
    GameSessionStatusReason
  - getStatusReason
```
public String getStatusReason()
```
    Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Returns:
    
    Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    See Also:
    
    GameSessionStatusReason
  - withStatusReason
```
public GameSession withStatusReason(String statusReason)
```
    Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Parameters:
    
    statusReason - Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionStatusReason
  - setStatusReason
```
public void setStatusReason(GameSessionStatusReason statusReason)
```
    Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Parameters:
    
    statusReason - Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    See Also:
    
    GameSessionStatusReason
  - withStatusReason
```
public GameSession withStatusReason(GameSessionStatusReason statusReason)
```
    Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Parameters:
    
    statusReason - Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameSessionStatusReason
  - 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). You can search for active game sessions based on this custom data with SearchGameSessions.
    
    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). You can search for active game sessions based on this custom data with SearchGameSessions.
  - 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). You can search for active game sessions based on this custom data with SearchGameSessions.
    
    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). You can search for active game sessions based on this custom data with SearchGameSessions.
  - withGameProperties
```
public GameSession 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). You can search for active game sessions based on this custom data with SearchGameSessions.
    
    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). You can search for active game sessions based on this custom data with SearchGameSessions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGameProperties
```
public GameSession 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). You can search for active game sessions based on this custom data with SearchGameSessions.
    
    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). You can search for active game sessions based on this custom data with SearchGameSessions.
    
    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.
    
    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.
  - 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.
    
    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.
  - withIpAddress
```
public GameSession 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.
    
    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.
    
    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 GameSession 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.
    
    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.
  - 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.
    
    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.
  - withPort
```
public GameSession 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlayerSessionCreationPolicy
```
public void setPlayerSessionCreationPolicy(String playerSessionCreationPolicy)
```
    Indicates whether or not the game session is accepting new players.
    
    Parameters:
    
    playerSessionCreationPolicy - Indicates whether or not the game session is accepting new players.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - getPlayerSessionCreationPolicy
```
public String getPlayerSessionCreationPolicy()
```
    Indicates whether or not the game session is accepting new players.
    
    Returns:
    
    Indicates whether or not the game session is accepting new players.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - withPlayerSessionCreationPolicy
```
public GameSession withPlayerSessionCreationPolicy(String playerSessionCreationPolicy)
```
    Indicates whether or not the game session is accepting new players.
    
    Parameters:
    
    playerSessionCreationPolicy - Indicates whether or not the game session is accepting new players.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - setPlayerSessionCreationPolicy
```
public void setPlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)
```
    Indicates whether or not the game session is accepting new players.
    
    Parameters:
    
    playerSessionCreationPolicy - Indicates whether or not the game session is accepting new players.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - withPlayerSessionCreationPolicy
```
public GameSession withPlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionCreationPolicy)
```
    Indicates whether or not the game session is accepting new players.
    
    Parameters:
    
    playerSessionCreationPolicy - Indicates whether or not the game session is accepting new players.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlayerSessionCreationPolicy
  - setCreatorId
```
public void setCreatorId(String creatorId)
```
    A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
    
    Parameters:
    
    creatorId - A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
  - getCreatorId
```
public String getCreatorId()
```
    A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
    
    Returns:
    
    A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
  - withCreatorId
```
public GameSession withCreatorId(String creatorId)
```
    A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
    
    Parameters:
    
    creatorId - A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
    
    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 GameSession 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 about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
    
    Parameters:
    
    matchmakerData - Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
  - getMatchmakerData
```
public String getMatchmakerData()
```
    Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
    
    Returns:
    
    Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
  - withMatchmakerData
```
public GameSession withMatchmakerData(String matchmakerData)
```
    Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
    
    Parameters:
    
    matchmakerData - Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(String location)
```
    The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
    
    Parameters:
    
    location - The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
  - getLocation
```
public String getLocation()
```
    The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
    
    Returns:
    
    The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
  - withLocation
```
public GameSession withLocation(String location)
```
    The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
    
    Parameters:
    
    location - The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
    
    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 GameSession 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 GameSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameSession

Method Detail

setGameSessionId

getGameSessionId

withGameSessionId

setName

getName

withName

setFleetId

getFleetId

withFleetId

setFleetArn

getFleetArn

withFleetArn

setCreationTime

getCreationTime

withCreationTime

setTerminationTime

getTerminationTime

withTerminationTime

setCurrentPlayerSessionCount

getCurrentPlayerSessionCount

withCurrentPlayerSessionCount

setMaximumPlayerSessionCount

getMaximumPlayerSessionCount

withMaximumPlayerSessionCount

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setStatusReason

withStatusReason

getGameProperties

setGameProperties

withGameProperties

withGameProperties

setIpAddress

getIpAddress

withIpAddress

setDnsName

getDnsName

withDnsName

setPort

getPort

withPort

setPlayerSessionCreationPolicy

getPlayerSessionCreationPolicy

withPlayerSessionCreationPolicy

setPlayerSessionCreationPolicy

withPlayerSessionCreationPolicy

setCreatorId

getCreatorId

withCreatorId

setGameSessionData

getGameSessionData

withGameSessionData

setMatchmakerData

getMatchmakerData

withMatchmakerData

setLocation

getLocation

withLocation

toString

equals

hashCode

clone

marshall