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.

Game-session-related operations include:
- CreateGameSession
- DescribeGameSessions
- DescribeGameSessionDetails
- SearchGameSessions
- UpdateGameSession
- GetGameSessionLogUrl
- Game session placements
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()` Time stamp indicating when this data object was created.
`String`	`getCreatorId()` Unique identifier for a player.
`Integer`	`getCurrentPlayerSessionCount()` Number of players currently in the game session.
`String`	`getFleetId()` Unique identifier for a fleet that the game session is running on.
`List<GameProperty>`	`getGameProperties()` Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
`String`	`getGameSessionData()` Set of developer-defined game session properties, formatted as a single string value.
`String`	`getGameSessionId()` Unique identifier for the game session.
`String`	`getIpAddress()` IP address of the game session.
`Integer`	`getMaximumPlayerSessionCount()` Maximum number of players that can be connected simultaneously to the game session.
`String`	`getName()` Descriptive label that is associated with a game session.
`String`	`getPlayerSessionCreationPolicy()` Indicates whether or not the game session is accepting new players.
`Integer`	`getPort()` Port number for the game session.
`String`	`getStatus()` Current status of the game session.
`Date`	`getTerminationTime()` 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)` Time stamp indicating when this data object was created.
`void`	`setCreatorId(String creatorId)` Unique identifier for a player.
`void`	`setCurrentPlayerSessionCount(Integer currentPlayerSessionCount)` Number of players currently in the game session.
`void`	`setFleetId(String fleetId)` Unique identifier for a fleet that the game session is running on.
`void`	`setGameProperties(Collection<GameProperty> gameProperties)` Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
`void`	`setGameSessionData(String gameSessionData)` Set of developer-defined game session properties, formatted as a single string value.
`void`	`setGameSessionId(String gameSessionId)` Unique identifier for the game session.
`void`	`setIpAddress(String ipAddress)` IP address of the game session.
`void`	`setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` Maximum number of players that can be connected simultaneously to the game session.
`void`	`setName(String name)` 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)` 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`	`setTerminationTime(Date terminationTime)` Time stamp indicating when this data object was terminated.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GameSession`	`withCreationTime(Date creationTime)` Time stamp indicating when this data object was created.
`GameSession`	`withCreatorId(String creatorId)` Unique identifier for a player.
`GameSession`	`withCurrentPlayerSessionCount(Integer currentPlayerSessionCount)` Number of players currently in the game session.
`GameSession`	`withFleetId(String fleetId)` Unique identifier for a fleet that the game session is running on.
`GameSession`	`withGameProperties(Collection<GameProperty> gameProperties)` Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
`GameSession`	`withGameProperties(GameProperty... gameProperties)` Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
`GameSession`	`withGameSessionData(String gameSessionData)` Set of developer-defined game session properties, formatted as a single string value.
`GameSession`	`withGameSessionId(String gameSessionId)` Unique identifier for the game session.
`GameSession`	`withIpAddress(String ipAddress)` IP address of the game session.
`GameSession`	`withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` Maximum number of players that can be connected simultaneously to the game session.
`GameSession`	`withName(String name)` 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)` 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`	`withTerminationTime(Date terminationTime)` 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)
```
    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 - 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()
```
    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:
    
    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)
```
    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 - 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)
```
    Descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    name - Descriptive label that is associated with a game session. Session names do not need to be unique.
  - getName
```
public String getName()
```
    Descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Returns:
    
    Descriptive label that is associated with a game session. Session names do not need to be unique.
  - withName
```
public GameSession withName(String name)
```
    Descriptive label that is associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    name - 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)
```
    Unique identifier for a fleet that the game session is running on.
    
    Parameters:
    
    fleetId - Unique identifier for a fleet that the game session is running on.
  - getFleetId
```
public String getFleetId()
```
    Unique identifier for a fleet that the game session is running on.
    
    Returns:
    
    Unique identifier for a fleet that the game session is running on.
  - withFleetId
```
public GameSession withFleetId(String fleetId)
```
    Unique identifier for a fleet that the game session is running on.
    
    Parameters:
    
    fleetId - Unique identifier for a fleet that the 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)
```
    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 - 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()
```
    Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    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)
```
    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 - 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)
```
    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 - 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()
```
    Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    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)
```
    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 - 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)
```
    Maximum number of players that can be connected simultaneously to the game session.
    
    Parameters:
    
    maximumPlayerSessionCount - Maximum number of players that can be connected simultaneously to the game session.
  - getMaximumPlayerSessionCount
```
public Integer getMaximumPlayerSessionCount()
```
    Maximum number of players that can be connected simultaneously to the game session.
    
    Returns:
    
    Maximum number of players that can be connected simultaneously to the game session.
  - withMaximumPlayerSessionCount
```
public GameSession withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)
```
    Maximum number of players that can be connected simultaneously to the game session.
    
    Parameters:
    
    maximumPlayerSessionCount - Maximum number of players that can be connected simultaneously to the game session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
  - getGameProperties
```
public List<GameProperty> getGameProperties()
```
    Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Returns:
    
    Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
  - setGameProperties
```
public void setGameProperties(Collection<GameProperty> gameProperties)
```
    Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Parameters:
    
    gameProperties - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
  - withGameProperties
```
public GameSession withGameProperties(GameProperty... gameProperties)
```
    Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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 - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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 GameSession withGameProperties(Collection<GameProperty> gameProperties)
```
    Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Parameters:
    
    gameProperties - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
    
    Parameters:
    
    ipAddress - IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
  - getIpAddress
```
public String getIpAddress()
```
    IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
    
    Returns:
    
    IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
  - withIpAddress
```
public GameSession withIpAddress(String ipAddress)
```
    IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
    
    Parameters:
    
    ipAddress - IP address of the game session. To connect to a Amazon 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.
  - setPort
```
public void setPort(Integer port)
```
    Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
    
    Parameters:
    
    port - Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
  - getPort
```
public Integer getPort()
```
    Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
    
    Returns:
    
    Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
  - withPort
```
public GameSession withPort(Integer port)
```
    Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
    
    Parameters:
    
    port - Port number for the game session. To connect to a Amazon 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)
```
    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 - 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()
```
    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:
    
    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)
```
    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 - 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)
```
    Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Parameters:
    
    gameSessionData - Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
  - getGameSessionData
```
public String getGameSessionData()
```
    Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Returns:
    
    Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
  - withGameSessionData
```
public GameSession withGameSessionData(String gameSessionData)
```
    Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Parameters:
    
    gameSessionData - Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public 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

setCreationTime

getCreationTime

withCreationTime

setTerminationTime

getTerminationTime

withTerminationTime

setCurrentPlayerSessionCount

getCurrentPlayerSessionCount

withCurrentPlayerSessionCount

setMaximumPlayerSessionCount

getMaximumPlayerSessionCount

withMaximumPlayerSessionCount

setStatus

getStatus

withStatus

setStatus

withStatus

getGameProperties

setGameProperties

withGameProperties

withGameProperties

setIpAddress

getIpAddress

withIpAddress

setPort

getPort

withPort

setPlayerSessionCreationPolicy

getPlayerSessionCreationPolicy

withPlayerSessionCreationPolicy

setPlayerSessionCreationPolicy

withPlayerSessionCreationPolicy

setCreatorId

getCreatorId

withCreatorId

setGameSessionData

getGameSessionData

withGameSessionData

toString

equals

hashCode

clone

marshall