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

Class GameSessionQueue

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameSessionQueue

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<GameSessionQueue.Builder,GameSessionQueue>

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

Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:

• The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.

• The length of time that placement requests can wait in the queue before timing out.

• A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.

Queue-related operations include the following:

• CreateGameSessionQueue

• DescribeGameSessionQueues

• UpdateGameSessionQueue

• DeleteGameSessionQueue

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GameSessionQueue.Builder

Method Summary

Modifier and Type	Method	Description
static GameSessionQueue.Builder	builder()
List<GameSessionQueueDestination>	destinations()	List of fleets that can be used to fulfill game session placement requests in the queue.
boolean	equals(Object obj)
String	gameSessionQueueArn()	Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	Descriptive label that is associated with queue.
List<PlayerLatencyPolicy>	playerLatencyPolicies()	Collection of latency policies to apply when processing game sessions placement requests with player latency information.
static Class<? extends GameSessionQueue.Builder>	serializableBuilderClass()
Integer	timeoutInSeconds()	Maximum time, in seconds, that a new game session placement request remains in the queue.
GameSessionQueue.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

name

public String name()

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

Returns:

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

gameSessionQueueArn

public String gameSessionQueueArn()

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Returns:

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

timeoutInSeconds

public Integer timeoutInSeconds()

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Returns:

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

playerLatencyPolicies

public List<PlayerLatencyPolicy> playerLatencyPolicies()

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

Returns:

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

destinations

public List<GameSessionQueueDestination> destinations()

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

Returns:

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

toBuilder

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

Returns:

a builder for type T

builder

public static GameSessionQueue.Builder builder()

serializableBuilderClass

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