software.amazon.awssdk.services.gamelift.model

Class GameSessionPlacement

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameSessionPlacement

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<GameSessionPlacement.Builder,GameSessionPlacement>

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

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

• StartGameSessionPlacement

• DescribeGameSessionPlacement

• StopGameSessionPlacement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameSessionPlacement.Builder

Method Summary

Modifier and Type	Method and Description
static GameSessionPlacement.Builder	builder()
Instant	endTime() Time stamp indicating when this request was completed, canceled, or timed out.
boolean	equals(Object obj)
List<GameProperty>	gameProperties() Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
String	gameSessionArn() Identifier for the game session created by this placement request.
String	gameSessionData() Set of developer-defined game session properties, formatted as a single string value.
String	gameSessionId() Unique identifier for the game session.
String	gameSessionName() Descriptive label that is associated with a game session.
String	gameSessionQueueName() Descriptive label that is associated with game session queue.
String	gameSessionRegion() Name of the region where the game session created by this placement request is running.
<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.
List<PlacedPlayerSession>	placedPlayerSessions() Collection of information on player sessions created in response to the game session placement request.
String	placementId() Unique identifier for a game session placement.
List<PlayerLatency>	playerLatencies() Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
Integer	port() Port number for the game session.
static Class<? extends GameSessionPlacement.Builder>	serializableBuilderClass()
Instant	startTime() Time stamp indicating when this request was placed in the queue.
GameSessionPlacementState	status() Current status of the game session placement request.
String	statusAsString() Current status of the game session placement request.
GameSessionPlacement.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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

placementId

public String placementId()

Unique identifier for a game session placement.

Returns:

Unique identifier for a game session placement.

gameSessionQueueName

public String gameSessionQueueName()

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Returns:

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

status

public GameSessionPlacementState status()

Current status of the game session placement request.

• PENDING -- The placement request is currently in the queue waiting to be processed.

• FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

If the service returns an enum value that is not available in the current SDK version, status will return GameSessionPlacementState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Current status of the game session placement request.

• PENDING -- The placement request is currently in the queue waiting to be processed.

• FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

See Also:

GameSessionPlacementState

statusAsString

public String statusAsString()

Current status of the game session placement request.

• PENDING -- The placement request is currently in the queue waiting to be processed.

• FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

If the service returns an enum value that is not available in the current SDK version, status will return GameSessionPlacementState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Current status of the game session placement request.

• PENDING -- The placement request is currently in the queue waiting to be processed.

• FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

• CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

• TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

See Also:

GameSessionPlacementState

gameProperties

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.

Returns:

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

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.

gameSessionName

public String gameSessionName()

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.

gameSessionId

public String gameSessionId()

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

gameSessionArn

public String gameSessionArn()

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

Returns:

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

gameSessionRegion

public String gameSessionRegion()

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

playerLatencies

public List<PlayerLatency> playerLatencies()

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

startTime

public Instant startTime()

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

endTime

public Instant endTime()

Time stamp indicating when this request was completed, canceled, or timed out.

Returns:

Time stamp indicating when this request was completed, canceled, or timed out.

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. This value is set once the new game session is placed (placement status is FULFILLED).

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. This value is set once the new game session is placed (placement status is FULFILLED).

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. This value is set once the new game session is placed (placement status is FULFILLED).

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. This value is set once the new game session is placed (placement status is FULFILLED).

placedPlayerSessions

public List<PlacedPlayerSession> placedPlayerSessions()

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

gameSessionData

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

Returns:

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

toBuilder

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

Returns:

a builder for type T

builder

public static GameSessionPlacement.Builder builder()

serializableBuilderClass

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.