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

Class GameSession

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameSession

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<GameSession.Builder,GameSession>

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

Properties describing a game session.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GameSession.Builder

Method Summary

Modifier and Type	Method	Description
static GameSession.Builder	builder()
Date	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 the game session is running on.
List<GameProperty>	gameProperties()	Set of developer-defined properties for a game session.
String	gameSessionId()	Unique identifier for the game session.
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.
String	playerSessionCreationPolicy()	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()
String	status()	Current status of the game session.
Date	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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

gameSessionId

public String gameSessionId()

Unique identifier for the game session. A game session ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .

Returns:

Unique identifier for the game session. A game session ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .

name

public String name()

Descriptive label that is associated with a game session. Session names do not need to be unique.

Returns:

Descriptive label that is associated with a game session. Session names do not need to be unique.

fleetId

public String fleetId()

Unique identifier for a fleet the game session is running on.

Returns:

Unique identifier for a fleet the 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").

currentPlayerSessionCount

public Integer currentPlayerSessionCount()

Number of players currently in the game session.

Returns:

Number of players currently in the game session.

maximumPlayerSessionCount

public Integer maximumPlayerSessionCount()

Maximum number of players that can be connected simultaneously to the game session.

Returns:

Maximum number of players that can be connected simultaneously to the game session.

status

public String status()

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

Returns:

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

See Also:

GameSessionStatus

gameProperties

public List<GameProperty> gameProperties()

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

Returns:

Set of developer-defined properties for a game session. These properties are passed to the server process hosting the game session.

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 game server, an app needs both the IP address and port number.

Returns:

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

playerSessionCreationPolicy

public String playerSessionCreationPolicy()

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

creatorId

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.

Returns:

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.

toBuilder

public GameSession.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<GameSession.Builder,GameSession>

Returns:

a builder for type T

builder

public static GameSession.Builder builder()

serializableBuilderClass

public static Class<? extends GameSession.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.