Package software.amazon.awssdk.services.gamelift.model

Class PlayerSession

java.lang.Object

software.amazon.awssdk.services.gamelift.model.PlayerSession

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<PlayerSession.Builder,PlayerSession>

@Generated("software.amazon.awssdk:codegen")
public class PlayerSession
extends Object
implements StructuredPojo, ToCopyableBuilder<PlayerSession.Builder,PlayerSession>

Properties describing a player session. A player session represents either a player reservation for a game session or actual player activity in a game session. 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.

Player session-related operations include:

• CreatePlayerSession

• CreatePlayerSessions

• DescribePlayerSessions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PlayerSession.Builder

Method Summary

Modifier and Type	Method	Description
static PlayerSession.Builder	builder()
Date	creationTime()	Time stamp indicating when this data object was created.
boolean	equals(Object obj)
String	fleetId()	Unique identifier for a fleet that the player's game session is running on.
String	gameSessionId()	Unique identifier for the game session that the player session is connected to.
int	hashCode()
String	ipAddress()	IP address of the game session.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	playerData()	Developer-defined information related to a player.
String	playerId()	Unique identifier for a player that is associated with this player session.
String	playerSessionId()	Unique identifier for a player session.
Integer	port()	Port number for the game session.
static Class<? extends PlayerSession.Builder>	serializableBuilderClass()
String	status()	Current status of the player session.
Date	terminationTime()	Time stamp indicating when this data object was terminated.
PlayerSession.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

playerSessionId

public String playerSessionId()

Unique identifier for a player session.

Returns:

Unique identifier for a player session.

playerId

public String playerId()

Unique identifier for a player that is associated with this player session.

Returns:

Unique identifier for a player that is associated with this player session.

gameSessionId

public String gameSessionId()

Unique identifier for the game session that the player session is connected to.

Returns:

Unique identifier for the game session that the player session is connected to.

fleetId

public String fleetId()

Unique identifier for a fleet that the player's game session is running on.

Returns:

Unique identifier for a fleet that the player's game session is running on.

creationTime

public 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").

Returns:

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

terminationTime

public 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").

Returns:

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

status

public 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 time-out 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 time-out limit (60 seconds).

See Also:

PlayerSessionStatus

ipAddress

public 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.

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.

port

public 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.

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.

playerData

public 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.

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.

toBuilder

public PlayerSession.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PlayerSession.Builder,PlayerSession>

Returns:

a builder for type T

builder

public static PlayerSession.Builder builder()

serializableBuilderClass

public static Class<? extends PlayerSession.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString 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.