Class GameSessionQueue
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GameSessionQueue.Builder
builder()
final String
Information that is added to all events that are related to this game session queue.final List
<GameSessionQueueDestination> A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FilterConfiguration
A list of locations where a queue is allowed to place new game sessions.final String
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Destinations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PlayerLatencyPolicies property.final String
name()
A descriptive label that is associated with game session queue.final String
An SNS topic ARN that is set up to receive game session placement notifications.final List
<PlayerLatencyPolicy> A set of policies that act as a sliding cap on player latency.final PriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.static Class
<? extends GameSessionQueue.Builder> final Integer
The maximum time, in seconds, that a new game session placement request remains in the queue.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Resource Name (ARN) that is assigned to a Amazon 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 Amazon GameLift game session queue ARN, the resource ID matches the Name value.- Returns:
- The Amazon Resource Name (ARN) that is assigned to a
Amazon 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 Amazon GameLift game session queue ARN, the resource ID matches the Name value.
-
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. By default, this property is set to600
.- 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. By default, this property is set to600
.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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
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
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
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
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 interfaceToCopyableBuilder<GameSessionQueue.Builder,
GameSessionQueue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-