PlayerSession (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PlayerSession
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.
- CreatePlayerSession
- CreatePlayerSessions
- DescribePlayerSessions
- Game session placements
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PlayerSession()

Constructors
Constructor and Description
`PlayerSession()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlayerSession`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` Time stamp indicating when this data object was created.
`String`	`getDnsName()` 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 the player's game session is running on.
`String`	`getFleetId()` A unique identifier for a fleet that the player's game session is running on.
`String`	`getGameSessionId()` A unique identifier for the game session that the player session is connected to.
`String`	`getIpAddress()` IP address of the instance that is running the game session.
`String`	`getPlayerData()` Developer-defined information related to a player.
`String`	`getPlayerId()` A unique identifier for a player that is associated with this player session.
`String`	`getPlayerSessionId()` A unique identifier for a player session.
`Integer`	`getPort()` Port number for the game session.
`String`	`getStatus()` Current status of the player 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`	`setDnsName(String dnsName)` 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 the player's game session is running on.
`void`	`setFleetId(String fleetId)` A unique identifier for a fleet that the player's game session is running on.
`void`	`setGameSessionId(String gameSessionId)` A unique identifier for the game session that the player session is connected to.
`void`	`setIpAddress(String ipAddress)` IP address of the instance that is running the game session.
`void`	`setPlayerData(String playerData)` Developer-defined information related to a player.
`void`	`setPlayerId(String playerId)` A unique identifier for a player that is associated with this player session.
`void`	`setPlayerSessionId(String playerSessionId)` A unique identifier for a player session.
`void`	`setPort(Integer port)` Port number for the game session.
`void`	`setStatus(PlayerSessionStatus status)` Current status of the player session.
`void`	`setStatus(String status)` Current status of the player session.
`void`	`setTerminationTime(Date terminationTime)` Time stamp indicating when this data object was terminated.
`String`	`toString()` Returns a string representation of this object.
`PlayerSession`	`withCreationTime(Date creationTime)` Time stamp indicating when this data object was created.
`PlayerSession`	`withDnsName(String dnsName)` DNS identifier assigned to the instance that is running the game session.
`PlayerSession`	`withFleetArn(String fleetArn)` The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
`PlayerSession`	`withFleetId(String fleetId)` A unique identifier for a fleet that the player's game session is running on.
`PlayerSession`	`withGameSessionId(String gameSessionId)` A unique identifier for the game session that the player session is connected to.
`PlayerSession`	`withIpAddress(String ipAddress)` IP address of the instance that is running the game session.
`PlayerSession`	`withPlayerData(String playerData)` Developer-defined information related to a player.
`PlayerSession`	`withPlayerId(String playerId)` A unique identifier for a player that is associated with this player session.
`PlayerSession`	`withPlayerSessionId(String playerSessionId)` A unique identifier for a player session.
`PlayerSession`	`withPort(Integer port)` Port number for the game session.
`PlayerSession`	`withStatus(PlayerSessionStatus status)` Current status of the player session.
`PlayerSession`	`withStatus(String status)` Current status of the player session.
`PlayerSession`	`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
  - PlayerSession
```
public PlayerSession()
```
- Method Detail
  - setPlayerSessionId
```
public void setPlayerSessionId(String playerSessionId)
```
    A unique identifier for a player session.
    
    Parameters:
    
    playerSessionId - A unique identifier for a player session.
  - getPlayerSessionId
```
public String getPlayerSessionId()
```
    A unique identifier for a player session.
    
    Returns:
    
    A unique identifier for a player session.
  - withPlayerSessionId
```
public PlayerSession withPlayerSessionId(String playerSessionId)
```
    A unique identifier for a player session.
    
    Parameters:
    
    playerSessionId - A unique identifier for a player session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlayerId
```
public void setPlayerId(String playerId)
```
    A unique identifier for a player that is associated with this player session.
    
    Parameters:
    
    playerId - A unique identifier for a player that is associated with this player session.
  - getPlayerId
```
public String getPlayerId()
```
    A unique identifier for a player that is associated with this player session.
    
    Returns:
    
    A unique identifier for a player that is associated with this player session.
  - withPlayerId
```
public PlayerSession withPlayerId(String playerId)
```
    A unique identifier for a player that is associated with this player session.
    
    Parameters:
    
    playerId - A unique identifier for a player that is associated with this player session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGameSessionId
```
public void setGameSessionId(String gameSessionId)
```
    A unique identifier for the game session that the player session is connected to.
    
    Parameters:
    
    gameSessionId - A unique identifier for the game session that the player session is connected to.
  - getGameSessionId
```
public String getGameSessionId()
```
    A unique identifier for the game session that the player session is connected to.
    
    Returns:
    
    A unique identifier for the game session that the player session is connected to.
  - withGameSessionId
```
public PlayerSession withGameSessionId(String gameSessionId)
```
    A unique identifier for the game session that the player session is connected to.
    
    Parameters:
    
    gameSessionId - A unique identifier for the game session that the player session is connected to.
    
    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 a fleet that the player's game session is running on.
    
    Parameters:
    
    fleetId - A unique identifier for a fleet that the player's game session is running on.
  - getFleetId
```
public String getFleetId()
```
    A unique identifier for a fleet that the player's game session is running on.
    
    Returns:
    
    A unique identifier for a fleet that the player's game session is running on.
  - withFleetId
```
public PlayerSession withFleetId(String fleetId)
```
    A unique identifier for a fleet that the player's game session is running on.
    
    Parameters:
    
    fleetId - A unique identifier for a fleet that the player's 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 the player's game session is running on.
    
    Parameters:
    
    fleetArn - The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
  - getFleetArn
```
public String getFleetArn()
```
    The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
    
    Returns:
    
    The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
  - withFleetArn
```
public PlayerSession withFleetArn(String fleetArn)
```
    The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
    
    Parameters:
    
    fleetArn - The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's 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 PlayerSession 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 PlayerSession 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.
  - setStatus
```
public void setStatus(String status)
```
    Current status of the player session.
    
    Possible player session statuses include the following:
    - RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    - ACTIVE -- The player has been validated by the server process and is currently connected.
    - COMPLETED -- The player connection has been dropped.
    - TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Parameters:
    status - Current status of the player session.
    
    Possible player session statuses include the following:
    
    RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    
    ACTIVE -- The player has been validated by the server process and is currently connected.
    
    COMPLETED -- The player connection has been dropped.
    
    TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    See Also:
    
    PlayerSessionStatus
  - getStatus
```
public String getStatus()
```
    Current status of the player session.
    
    Possible player session statuses include the following:
    - RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    - ACTIVE -- The player has been validated by the server process and is currently connected.
    - COMPLETED -- The player connection has been dropped.
    - TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Returns:
    Current status of the player session.
    
    Possible player session statuses include the following:
    
    RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    
    ACTIVE -- The player has been validated by the server process and is currently connected.
    
    COMPLETED -- The player connection has been dropped.
    
    TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    See Also:
    
    PlayerSessionStatus
  - withStatus
```
public PlayerSession withStatus(String status)
```
    Current status of the player session.
    
    Possible player session statuses include the following:
    - RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    - ACTIVE -- The player has been validated by the server process and is currently connected.
    - COMPLETED -- The player connection has been dropped.
    - TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Parameters:
    status - Current status of the player session.
    
    Possible player session statuses include the following:
    
    RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    
    ACTIVE -- The player has been validated by the server process and is currently connected.
    
    COMPLETED -- The player connection has been dropped.
    
    TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlayerSessionStatus
  - setStatus
```
public void setStatus(PlayerSessionStatus status)
```
    Current status of the player session.
    
    Possible player session statuses include the following:
    - RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    - ACTIVE -- The player has been validated by the server process and is currently connected.
    - COMPLETED -- The player connection has been dropped.
    - TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Parameters:
    status - Current status of the player session.
    
    Possible player session statuses include the following:
    
    RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    
    ACTIVE -- The player has been validated by the server process and is currently connected.
    
    COMPLETED -- The player connection has been dropped.
    
    TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    See Also:
    
    PlayerSessionStatus
  - withStatus
```
public PlayerSession withStatus(PlayerSessionStatus status)
```
    Current status of the player session.
    
    Possible player session statuses include the following:
    - RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    - ACTIVE -- The player has been validated by the server process and is currently connected.
    - COMPLETED -- The player connection has been dropped.
    - TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Parameters:
    status - Current status of the player session.
    
    Possible player session statuses include the following:
    
    RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
    
    ACTIVE -- The player has been validated by the server process and is currently connected.
    
    COMPLETED -- The player connection has been dropped.
    
    TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlayerSessionStatus
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
    
    Parameters:
    
    ipAddress - IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
  - getIpAddress
```
public String getIpAddress()
```
    IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
    
    Returns:
    
    IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
  - withIpAddress
```
public PlayerSession withIpAddress(String ipAddress)
```
    IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
    
    Parameters:
    
    ipAddress - IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDnsName
```
public void setDnsName(String dnsName)
```
    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 - 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()
```
    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:
    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 PlayerSession withDnsName(String dnsName)
```
    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 - 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)
```
    Port number for the game session. To connect to a Amazon 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 Amazon 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 Amazon GameLift server process, an app needs both the IP address and port number.
    
    Returns:
    
    Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
  - withPort
```
public PlayerSession withPort(Integer port)
```
    Port number for the game session. To connect to a Amazon 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 Amazon 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.
  - setPlayerData
```
public void setPlayerData(String playerData)
```
    Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
    
    Parameters:
    
    playerData - Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
  - getPlayerData
```
public String getPlayerData()
```
    Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
    
    Returns:
    
    Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
  - withPlayerData
```
public PlayerSession withPlayerData(String playerData)
```
    Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
    
    Parameters:
    
    playerData - Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
    
    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 PlayerSession 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 PlayerSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlayerSession

Method Detail

setPlayerSessionId

getPlayerSessionId

withPlayerSessionId

setPlayerId

getPlayerId

withPlayerId

setGameSessionId

getGameSessionId

withGameSessionId

setFleetId

getFleetId

withFleetId

setFleetArn

getFleetArn

withFleetArn

setCreationTime

getCreationTime

withCreationTime

setTerminationTime

getTerminationTime

withTerminationTime

setStatus

getStatus

withStatus

setStatus

withStatus

setIpAddress

getIpAddress

withIpAddress

setDnsName

getDnsName

withDnsName

setPort

getPort

withPort

setPlayerData

getPlayerData

withPlayerData

toString

equals

hashCode

clone

marshall