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 for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.

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()
String	customEventData() Information that is added to all events that are related to this game session queue.
List<GameSessionQueueDestination>	destinations() A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilterConfiguration	filterConfiguration() A list of locations where a queue is allowed to place new game sessions.
String	gameSessionQueueArn() The 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() For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
boolean	hasPlayerLatencyPolicies() For responses, this returns true if the service returned a value for the PlayerLatencyPolicies property.
String	name() A descriptive label that is associated with game session queue.
String	notificationTarget() An SNS topic ARN that is set up to receive game session placement notifications.
List<PlayerLatencyPolicy>	playerLatencyPolicies() A set of policies that act as a sliding cap on player latency.
PriorityConfiguration	priorityConfiguration() Custom settings to use when prioritizing destinations and locations for game session placements.
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 final 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 final String gameSessionQueueArn()

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a GameLift game session queue ARN, the resource ID matches the Name value.

Returns:

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a GameLift game session queue ARN, the resource ID matches the Name value.

timeoutInSeconds

public final 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 final boolean hasPlayerLatencyPolicies()

For responses, this returns true if the service returned a value for the PlayerLatencyPolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

playerLatencyPolicies

public final List<PlayerLatencyPolicy> playerLatencyPolicies()

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlayerLatencyPolicies() method.

Returns:

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

hasDestinations

public final boolean hasDestinations()

For responses, this returns true if the service returned a value for the Destinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

destinations

public final List<GameSessionQueueDestination> destinations()

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinations() method.

Returns:

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

filterConfiguration

public final FilterConfiguration filterConfiguration()

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

Returns:

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

priorityConfiguration

public final PriorityConfiguration priorityConfiguration()

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

Returns:

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

customEventData

public final String customEventData()

Information that is added to all events that are related to this game session queue.

Returns:

Information that is added to all events that are related to this game session queue.

notificationTarget

public final String notificationTarget()

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Returns:

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

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