software.amazon.awssdk.services.gamelift.model

Class CreateGameSessionQueueRequest

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

Method Summary

Modifier and Type	Method and Description
static CreateGameSessionQueueRequest.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)
<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.
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 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 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 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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

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.

hasTags

public 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 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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo