@Generated(value="software.amazon.awssdk:codegen") public final class CreateGameSessionQueueRequest extends GameLiftRequest implements ToCopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateGameSessionQueueRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateGameSessionQueueRequest.Builder |
builder() |
String |
customEventData()
Information to be 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.
|
<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.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags 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 CreateGameSessionQueueRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of labels to assign to the new game session queue resource.
|
Integer |
timeoutInSeconds()
The maximum time, in seconds, that a new game session placement request remains in the queue.
|
CreateGameSessionQueueRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
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. By default, this
property is set to 600.
TIMED_OUT status. By
default, this property is set to 600.public final boolean hasPlayerLatencyPolicies()
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.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.
public final boolean hasDestinations()
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.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.
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.
us-west-2. If this parameter is not set,
game sessions can be placed in any queue location.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.
public final String customEventData()
Information to be added to all events that are related to this game session queue.
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.
public final boolean hasTags()
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.public final List<Tag> tags()
A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
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 hasTags() method.
public CreateGameSessionQueueRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>toBuilder in class GameLiftRequestpublic static CreateGameSessionQueueRequest.Builder builder()
public static Class<? extends CreateGameSessionQueueRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.