software.amazon.awssdk.services.gamelift.model

Class GameSessionQueue

java.lang.Object

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

All Implemented Interfaces:

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

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

• CreateGameSessionQueue

• DescribeGameSessionQueues

• UpdateGameSessionQueue

• DeleteGameSessionQueue

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameSessionQueue.Builder

Method Summary

Modifier and Type	Method and Description
static GameSessionQueue.Builder	builder()
List<GameSessionQueueDestination>	destinations() A list of fleets that can be used to fulfill game session placement requests in the queue.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameSessionQueueArn() Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations() Returns true if the Destinations 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	hasPlayerLatencyPolicies() Returns true if the PlayerLatencyPolicies 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	name() A descriptive label that is associated with game session queue.
List<PlayerLatencyPolicy>	playerLatencyPolicies() A collection of latency policies to apply when processing game sessions placement requests with player latency information.
List<SdkField<?>>	sdkFields()
static Class<? extends GameSessionQueue.Builder>	serializableBuilderClass()
Integer	timeoutInSeconds() The maximum time, in seconds, that a new game session placement request remains in the queue.
GameSessionQueue.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

name

public String name()

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.

gameSessionQueueArn

public String gameSessionQueueArn()

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.

Returns:

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.

timeoutInSeconds

public Integer timeoutInSeconds()

The 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:

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

hasPlayerLatencyPolicies

public boolean hasPlayerLatencyPolicies()

Returns true if the PlayerLatencyPolicies 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.

playerLatencyPolicies

public List<PlayerLatencyPolicy> playerLatencyPolicies()

A 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, the policy 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.

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

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

Returns:

A 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, the policy 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.

hasDestinations

public boolean hasDestinations()

Returns true if the Destinations 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.

destinations

public List<GameSessionQueueDestination> destinations()

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

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

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

Returns:

A 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GameSessionQueue.Builder,GameSessionQueue>

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

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo