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

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() List of fleets that can be used to fulfill game session placement requests in the queue.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() Descriptive label that is associated with game session queue.
List<PlayerLatencyPolicy>	playerLatencyPolicies() 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()
Integer	timeoutInSeconds() Maximum time, in seconds, that a new game session placement request remains in the queue.
CreateGameSessionQueueRequest.Builder	toBuilder()
String	toString()

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

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Returns:

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

timeoutInSeconds

public Integer timeoutInSeconds()

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:

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.

playerLatencyPolicies

public List<PlayerLatencyPolicy> playerLatencyPolicies()

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, it 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 requests will fail.

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

Returns:

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, it 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 requests will fail.

destinations

public List<GameSessionQueueDestination> destinations()

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.

Returns:

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.

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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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