software.amazon.awssdk.services.gamelift.model

Class GameSessionPlacement

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GameSessionPlacement.Builder,GameSessionPlacement>

@Generated(value="software.amazon.awssdk:codegen")
public final class GameSessionPlacement
extends Object
implements SdkPojo, Serializable, 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

See Also:

Serialized Form

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()
String	dnsName() DNS identifier assigned to the instance that is running the game session.
Instant	endTime() Time stamp indicating when this request was completed, canceled, or timed out.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<GameProperty>	gameProperties() Set of custom properties for a game session, formatted as key:value pairs.
String	gameSessionArn() Identifier for the game session created by this placement request.
String	gameSessionData() Set of custom game session properties, formatted as a single string value.
String	gameSessionId() A unique identifier for the game session.
String	gameSessionName() A descriptive label that is associated with a game session.
String	gameSessionQueueName() A 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)
boolean	hasGameProperties() Returns true if the GameProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPlacedPlayerSessions() Returns true if the PlacedPlayerSessions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasPlayerLatencies() Returns true if the PlayerLatencies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	ipAddress() IP address of the instance that is running the game session.
String	matchmakerData() Information on the matchmaking process for this game.
Integer	maximumPlayerSessionCount() The maximum number of players that can be connected simultaneously to the game session.
List<PlacedPlayerSession>	placedPlayerSessions() A collection of information on player sessions created in response to the game session placement request.
String	placementId() A 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.
List<SdkField<?>>	sdkFields()
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()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

placementId

public final String placementId()

A unique identifier for a game session placement.

Returns:

A unique identifier for a game session placement.

gameSessionQueueName

public final String gameSessionQueueName()

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Returns:

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

status

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

• FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

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.

• FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

See Also:

GameSessionPlacementState

statusAsString

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

• FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

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.

• FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

See Also:

GameSessionPlacementState

hasGameProperties

public final boolean hasGameProperties()

Returns true if the GameProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

gameProperties

public final List<GameProperty> gameProperties()

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

You can use hasGameProperties() to see if a value was sent in this field.

Returns:

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

maximumPlayerSessionCount

public final Integer maximumPlayerSessionCount()

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

Returns:

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

gameSessionName

public final String gameSessionName()

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

Returns:

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

gameSessionId

public final String gameSessionId()

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

Returns:

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

gameSessionArn

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

hasPlayerLatencies

public final boolean hasPlayerLatencies()

Returns true if the PlayerLatencies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

playerLatencies

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

You can use hasPlayerLatencies() to see if a value was sent in this field.

Returns:

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

startTime

public final 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 final 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 final String ipAddress()

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number. This value is set once the new game session is placed (placement status is FULFILLED).

dnsName

public final String dnsName()

DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

• Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Returns:

DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

• Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

port

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

hasPlacedPlayerSessions

public final boolean hasPlacedPlayerSessions()

Returns true if the PlacedPlayerSessions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

placedPlayerSessions

public final List<PlacedPlayerSession> placedPlayerSessions()

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

You can use hasPlacedPlayerSessions() to see if a value was sent in this field.

Returns:

A 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 final String gameSessionData()

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Returns:

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

matchmakerData

public final String matchmakerData()

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

Returns:

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

toBuilder

public GameSessionPlacement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameSessionPlacement.Builder,GameSessionPlacement>

builder

public static GameSessionPlacement.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo