Package software.amazon.awssdk.services.gamelift.model

Interface GameSessionQueue.Builder

All Superinterfaces:

CopyableBuilder<GameSessionQueue.Builder,GameSessionQueue>, SdkBuilder<GameSessionQueue.Builder,GameSessionQueue>

Enclosing class:

GameSessionQueue

public static interface GameSessionQueue.Builder
extends CopyableBuilder<GameSessionQueue.Builder,GameSessionQueue>

Method Summary

Modifier and Type	Method	Description
GameSessionQueue.Builder	destinations(Collection<GameSessionQueueDestination> destinations)	List of fleets that can be used to fulfill game session placement requests in the queue.
GameSessionQueue.Builder	destinations(GameSessionQueueDestination... destinations)	List of fleets that can be used to fulfill game session placement requests in the queue.
GameSessionQueue.Builder	gameSessionQueueArn(String gameSessionQueueArn)	Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it.
GameSessionQueue.Builder	name(String name)	Descriptive label that is associated with queue.
GameSessionQueue.Builder	playerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies)	Collection of latency policies to apply when processing game sessions placement requests with player latency information.
GameSessionQueue.Builder	playerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies)	Collection of latency policies to apply when processing game sessions placement requests with player latency information.
GameSessionQueue.Builder	timeoutInSeconds(Integer timeoutInSeconds)	Maximum time, in seconds, that a new game session placement request remains in the queue.

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

copy

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

apply, build

Method Detail

name

GameSessionQueue.Builder name(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

gameSessionQueueArn

GameSessionQueue.Builder gameSessionQueueArn(String gameSessionQueueArn)

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Parameters:

gameSessionQueueArn - Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Returns:

Returns a reference to this object so that method calls can be chained together.

timeoutInSeconds

GameSessionQueue.Builder timeoutInSeconds(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

playerLatencyPolicies

GameSessionQueue.Builder playerLatencyPolicies(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

playerLatencyPolicies

GameSessionQueue.Builder playerLatencyPolicies(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.

NOTE: This method appends the values to the existing list (if any). Use #setPlayerLatencyPolicies(java.util.Collection) or #withPlayerLatencyPolicies(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinations

GameSessionQueue.Builder destinations(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinations

GameSessionQueue.Builder destinations(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.

NOTE: This method appends the values to the existing list (if any). Use #setDestinations(java.util.Collection) or #withDestinations(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.