public static interface PlayerSession.Builder extends CopyableBuilder<PlayerSession.Builder,PlayerSession>
Modifier and Type | Method and Description |
---|---|
PlayerSession.Builder |
creationTime(Instant creationTime)
Time stamp indicating when this data object was created.
|
PlayerSession.Builder |
fleetId(String fleetId)
Unique identifier for a fleet that the player's game session is running on.
|
PlayerSession.Builder |
gameSessionId(String gameSessionId)
Unique identifier for the game session that the player session is connected to.
|
PlayerSession.Builder |
ipAddress(String ipAddress)
IP address of the game session.
|
PlayerSession.Builder |
playerData(String playerData)
Developer-defined information related to a player.
|
PlayerSession.Builder |
playerId(String playerId)
Unique identifier for a player that is associated with this player session.
|
PlayerSession.Builder |
playerSessionId(String playerSessionId)
Unique identifier for a player session.
|
PlayerSession.Builder |
port(Integer port)
Port number for the game session.
|
PlayerSession.Builder |
status(PlayerSessionStatus status)
Current status of the player session.
|
PlayerSession.Builder |
status(String status)
Current status of the player session.
|
PlayerSession.Builder |
terminationTime(Instant terminationTime)
Time stamp indicating when this data object was terminated.
|
copy
apply, build
PlayerSession.Builder playerSessionId(String playerSessionId)
Unique identifier for a player session.
playerSessionId
- Unique identifier for a player session.PlayerSession.Builder playerId(String playerId)
Unique identifier for a player that is associated with this player session.
playerId
- Unique identifier for a player that is associated with this player session.PlayerSession.Builder gameSessionId(String gameSessionId)
Unique identifier for the game session that the player session is connected to.
gameSessionId
- Unique identifier for the game session that the player session is connected to.PlayerSession.Builder fleetId(String fleetId)
Unique identifier for a fleet that the player's game session is running on.
fleetId
- Unique identifier for a fleet that the player's game session is running on.PlayerSession.Builder creationTime(Instant creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
creationTime
- Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057").PlayerSession.Builder terminationTime(Instant terminationTime)
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
terminationTime
- Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time
as milliseconds (for example "1469498468.057").PlayerSession.Builder status(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).
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).
PlayerSessionStatus
,
PlayerSessionStatus
PlayerSession.Builder status(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).
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).
PlayerSessionStatus
,
PlayerSessionStatus
PlayerSession.Builder ipAddress(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.
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.PlayerSession.Builder port(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.
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.PlayerSession.Builder playerData(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.
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.