CreateGameSessionQueueRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.gamelift.model.GameLiftRequest
    - - software.amazon.awssdk.services.gamelift.model.CreateGameSessionQueueRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateGameSessionQueueRequest
extends GameLiftRequest
implements ToCopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>

Represents the input for a request operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateGameSessionQueueRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateGameSessionQueueRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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).
`boolean`	`hasTags()` Returns true if the Tags 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.
`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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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.
  - 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()
```
    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 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.
    
    You can use hasPlayerLatencyPolicies() to see if a value was sent in this field.
    
    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()
```
    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 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.
    
    You can use hasDestinations() to see if a value was sent in this field.
    
    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 AWS 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 AWS 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 to be added to all events that are related to this game session queue.
    
    Returns:
    
    Information to be 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.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags 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.
  - tags
```
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 AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
  - toBuilder
```
public CreateGameSessionQueueRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>
    
    Specified by:
    
    toBuilder in class GameLiftRequest
  - builder
```
public static CreateGameSessionQueueRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGameSessionQueueRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateGameSessionQueueRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

timeoutInSeconds

hasPlayerLatencyPolicies

playerLatencyPolicies

hasDestinations

destinations

filterConfiguration

priorityConfiguration

customEventData

notificationTarget

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields