@Generated(value="software.amazon.awssdk:codegen") public class GameSession extends Object implements StructuredPojo, ToCopyableBuilder<GameSession.Builder,GameSession>
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:
Modifier and Type | Class and Description |
---|---|
static interface |
GameSession.Builder |
Modifier and Type | Method and Description |
---|---|
static GameSession.Builder |
builder() |
Instant |
creationTime()
Time stamp indicating when this data object was created.
|
String |
creatorId()
Unique identifier for a player.
|
Integer |
currentPlayerSessionCount()
Number of players currently in the game session.
|
boolean |
equals(Object obj) |
String |
fleetId()
Unique identifier for a fleet that the game session is running on.
|
List<GameProperty> |
gameProperties()
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
String |
gameSessionData()
Set of developer-defined game session properties, formatted as a single string value.
|
String |
gameSessionId()
Unique identifier for the game session.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
ipAddress()
IP address of the game session.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Integer |
maximumPlayerSessionCount()
Maximum number of players that can be connected simultaneously to the game session.
|
String |
name()
Descriptive label that is associated with a game session.
|
PlayerSessionCreationPolicy |
playerSessionCreationPolicy()
Indicates whether or not the game session is accepting new players.
|
String |
playerSessionCreationPolicyString()
Indicates whether or not the game session is accepting new players.
|
Integer |
port()
Port number for the game session.
|
static Class<? extends GameSession.Builder> |
serializableBuilderClass() |
GameSessionStatus |
status()
Current status of the game session.
|
String |
statusString()
Current status of the game session.
|
Instant |
terminationTime()
Time stamp indicating when this data object was terminated.
|
GameSession.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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>
.
arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
.public String name()
Descriptive label that is associated with a game session. Session names do not need to be unique.
public String fleetId()
Unique identifier for a fleet that the game session is running on.
public 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").
public 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").
public Integer currentPlayerSessionCount()
Number of players currently in the game session.
public Integer maximumPlayerSessionCount()
Maximum number of players that can be connected simultaneously to the game session.
public GameSessionStatus status()
Current status of the game session. A game session must have an ACTIVE
status to have player
sessions.
If the service returns an enum value that is not available in the current SDK version, status
will
return GameSessionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
ACTIVE
status to have player
sessions.GameSessionStatus
public String statusString()
Current status of the game session. A game session must have an ACTIVE
status to have player
sessions.
If the service returns an enum value that is not available in the current SDK version, status
will
return GameSessionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
ACTIVE
status to have player
sessions.GameSessionStatus
public List<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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public 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.
public PlayerSessionCreationPolicy playerSessionCreationPolicy()
Indicates whether or not the game session is accepting new players.
If the service returns an enum value that is not available in the current SDK version,
playerSessionCreationPolicy
will return PlayerSessionCreationPolicy.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from playerSessionCreationPolicyString()
.
PlayerSessionCreationPolicy
public String playerSessionCreationPolicyString()
Indicates whether or not the game session is accepting new players.
If the service returns an enum value that is not available in the current SDK version,
playerSessionCreationPolicy
will return PlayerSessionCreationPolicy.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from playerSessionCreationPolicyString()
.
PlayerSessionCreationPolicy
public 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.
public 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).
public GameSession.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GameSession.Builder,GameSession>
public static GameSession.Builder builder()
public static Class<? extends GameSession.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.