GameSession (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class GameSession
extends Object
implements Serializable, Cloneable
```
Properties describing a game session.

See Also:

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()` Player ID of the person or entity that created the game session.
`Integer`	`getCurrentPlayerSessionCount()` Number of players currently in the game session.
`String`	`getFleetId()` Unique identifier for a fleet.
`List<GameProperty>`	`getGameProperties()` Set of custom properties for the game session.
`String`	`getGameSessionId()` Unique identifier for a game session.
`String`	`getIpAddress()` IP address of the game session.
`Integer`	`getMaximumPlayerSessionCount()` Maximum number of players allowed in the game session.
`String`	`getName()` Descriptive label 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`	`setCreationTime(Date creationTime)` Time stamp indicating when this data object was created.
`void`	`setCreatorId(String creatorId)` Player ID of the person or entity that created the game session.
`void`	`setCurrentPlayerSessionCount(Integer currentPlayerSessionCount)` Number of players currently in the game session.
`void`	`setFleetId(String fleetId)` Unique identifier for a fleet.
`void`	`setGameProperties(Collection<GameProperty> gameProperties)` Set of custom properties for the game session.
`void`	`setGameSessionId(String gameSessionId)` Unique identifier for a game session.
`void`	`setIpAddress(String ipAddress)` IP address of the game session.
`void`	`setMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` Maximum number of players allowed in the game session.
`void`	`setName(String name)` Descriptive label 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)` Player ID of the person or entity that created the game session.
`GameSession`	`withCurrentPlayerSessionCount(Integer currentPlayerSessionCount)` Number of players currently in the game session.
`GameSession`	`withFleetId(String fleetId)` Unique identifier for a fleet.
`GameSession`	`withGameProperties(Collection<GameProperty> gameProperties)` Set of custom properties for the game session.
`GameSession`	`withGameProperties(GameProperty... gameProperties)` Set of custom properties for the game session.
`GameSession`	`withGameSessionId(String gameSessionId)` Unique identifier for a game session.
`GameSession`	`withIpAddress(String ipAddress)` IP address of the game session.
`GameSession`	`withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)` Maximum number of players allowed in the game session.
`GameSession`	`withName(String name)` Descriptive label 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 a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
    
    Parameters:
    
    gameSessionId - Unique identifier for a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
  - getGameSessionId
```
public String getGameSessionId()
```
    Unique identifier for a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
    
    Returns:
    
    Unique identifier for a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
  - withGameSessionId
```
public GameSession withGameSessionId(String gameSessionId)
```
    Unique identifier for a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
    
    Parameters:
    
    gameSessionId - Unique identifier for a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Descriptive label associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    name - Descriptive label associated with a game session. Session names do not need to be unique.
  - getName
```
public String getName()
```
    Descriptive label associated with a game session. Session names do not need to be unique.
    
    Returns:
    
    Descriptive label associated with a game session. Session names do not need to be unique.
  - withName
```
public GameSession withName(String name)
```
    Descriptive label associated with a game session. Session names do not need to be unique.
    
    Parameters:
    
    name - Descriptive label 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.
    
    Parameters:
    
    fleetId - Unique identifier for a fleet.
  - getFleetId
```
public String getFleetId()
```
    Unique identifier for a fleet.
    
    Returns:
    
    Unique identifier for a fleet.
  - withFleetId
```
public GameSession withFleetId(String fleetId)
```
    Unique identifier for a fleet.
    
    Parameters:
    
    fleetId - Unique identifier for a fleet.
    
    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 (ex: "1469498468.057").
    
    Parameters:
    
    creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "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 (ex: "1469498468.057").
    
    Returns:
    
    Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "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 (ex: "1469498468.057").
    
    Parameters:
    
    creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "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 (ex: "1469498468.057").
    
    Parameters:
    
    terminationTime - Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "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 (ex: "1469498468.057").
    
    Returns:
    
    Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "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 (ex: "1469498468.057").
    
    Parameters:
    
    terminationTime - Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "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 allowed in the game session.
    
    Parameters:
    
    maximumPlayerSessionCount - Maximum number of players allowed in the game session.
  - getMaximumPlayerSessionCount
```
public Integer getMaximumPlayerSessionCount()
```
    Maximum number of players allowed in the game session.
    
    Returns:
    
    Maximum number of players allowed in the game session.
  - withMaximumPlayerSessionCount
```
public GameSession withMaximumPlayerSessionCount(Integer maximumPlayerSessionCount)
```
    Maximum number of players allowed in the game session.
    
    Parameters:
    
    maximumPlayerSessionCount - Maximum number of players allowed in 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 be in an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must be in an ACTIVE status to have player sessions.
    
    See Also:
    
    GameSessionStatus
  - getStatus
```
public String getStatus()
```
    Current status of the game session. A game session must be in an ACTIVE status to have player sessions.
    
    Returns:
    
    Current status of the game session. A game session must be in 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 be in an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must be in 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 be in an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must be in 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 be in an ACTIVE status to have player sessions.
    
    Parameters:
    
    status - Current status of the game session. A game session must be in 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 custom properties for the game session.
    
    Returns:
    
    Set of custom properties for the game session.
  - setGameProperties
```
public void setGameProperties(Collection<GameProperty> gameProperties)
```
    Set of custom properties for the game session.
    
    Parameters:
    
    gameProperties - Set of custom properties for the game session.
  - withGameProperties
```
public GameSession withGameProperties(GameProperty... gameProperties)
```
    Set of custom properties for the game session.
    
    NOTE: This method appends the values to the existing list (if any). Use setGameProperties(java.util.Collection) or withGameProperties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    gameProperties - Set of custom properties for the 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 custom properties for the game session.
    
    Parameters:
    
    gameProperties - Set of custom properties for the 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 GameLift server process, an app needs both the IP address and port number.
    
    Parameters:
    
    ipAddress - IP address of the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
  - getIpAddress
```
public String getIpAddress()
```
    IP address of the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
    
    Returns:
    
    IP address of the game session. To connect to a GameLift server process, 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 GameLift server process, an app needs both the IP address and port number.
    
    Parameters:
    
    ipAddress - IP address of the game session. To connect to a GameLift server process, 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 GameLift server process, an app needs both the IP address and port number.
    
    Parameters:
    
    port - Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
  - getPort
```
public Integer getPort()
```
    Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
    
    Returns:
    
    Port number for the game session. To connect to a GameLift server process, 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 GameLift server process, an app needs both the IP address and port number.
    
    Parameters:
    
    port - Port number for the game session. To connect to a GameLift server process, 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)
```
    Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.
    
    Parameters:
    
    creatorId - Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.
  - getCreatorId
```
public String getCreatorId()
```
    Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.
    
    Returns:
    
    Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.
  - withCreatorId
```
public GameSession withCreatorId(String creatorId)
```
    Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.
    
    Parameters:
    
    creatorId - Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.
    
    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

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

toString

equals

hashCode

clone