software.amazon.awssdk.services.gamelift.model

Interface GameSessionQueue.Builder

All Superinterfaces:

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

Enclosing class:

GameSessionQueue

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

Method Summary

Modifier and Type	Method and Description
GameSessionQueue.Builder	customEventData(String customEventData) Information that is added to all events that are related to this game session queue.
GameSessionQueue.Builder	destinations(Collection<GameSessionQueueDestination> destinations) A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
GameSessionQueue.Builder	destinations(Consumer<GameSessionQueueDestination.Builder>... destinations) A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
GameSessionQueue.Builder	destinations(GameSessionQueueDestination... destinations) A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
default GameSessionQueue.Builder	filterConfiguration(Consumer<FilterConfiguration.Builder> filterConfiguration) A list of locations where a queue is allowed to place new game sessions.
GameSessionQueue.Builder	filterConfiguration(FilterConfiguration filterConfiguration) A list of locations where a queue is allowed to place new game sessions.
GameSessionQueue.Builder	gameSessionQueueArn(String gameSessionQueueArn) The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
GameSessionQueue.Builder	name(String name) A descriptive label that is associated with game session queue.
GameSessionQueue.Builder	notificationTarget(String notificationTarget) An SNS topic ARN that is set up to receive game session placement notifications.
GameSessionQueue.Builder	playerLatencyPolicies(Collection<PlayerLatencyPolicy> playerLatencyPolicies) A set of policies that act as a sliding cap on player latency.
GameSessionQueue.Builder	playerLatencyPolicies(Consumer<PlayerLatencyPolicy.Builder>... playerLatencyPolicies) A set of policies that act as a sliding cap on player latency.
GameSessionQueue.Builder	playerLatencyPolicies(PlayerLatencyPolicy... playerLatencyPolicies) A set of policies that act as a sliding cap on player latency.
default GameSessionQueue.Builder	priorityConfiguration(Consumer<PriorityConfiguration.Builder> priorityConfiguration) Custom settings to use when prioritizing destinations and locations for game session placements.
GameSessionQueue.Builder	priorityConfiguration(PriorityConfiguration priorityConfiguration) Custom settings to use when prioritizing destinations and locations for game session placements.
GameSessionQueue.Builder	timeoutInSeconds(Integer timeoutInSeconds) The maximum time, in seconds, that a new game session placement request remains in the queue.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

GameSessionQueue.Builder name(String name)

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Parameters:

name - A descriptive label that is associated with game session 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)

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

Parameters:

gameSessionQueueArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift game session queue ARN, the resource ID matches the Name value.

Returns:

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

timeoutInSeconds

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

Parameters:

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.

Returns:

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

playerLatencyPolicies

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

Parameters:

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.

Returns:

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

playerLatencyPolicies

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

Parameters:

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.

Returns:

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

playerLatencyPolicies

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

This is a convenience method that creates an instance of the PlayerLatencyPolicy.Builder avoiding the need to create one manually via PlayerLatencyPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #playerLatencyPolicies(List).

Parameters:

playerLatencyPolicies - a consumer that will call methods on PlayerLatencyPolicy.Builder

Returns:

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

See Also:

#playerLatencyPolicies(java.util.Collection)

destinations

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

Parameters:

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.

Returns:

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

destinations

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

Parameters:

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.

Returns:

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

destinations

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

This is a convenience method that creates an instance of the GameSessionQueueDestination.Builder avoiding the need to create one manually via GameSessionQueueDestination.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #destinations(List).

Parameters:

destinations - a consumer that will call methods on GameSessionQueueDestination.Builder

Returns:

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

See Also:

#destinations(java.util.Collection)

filterConfiguration

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

Parameters:

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.

Returns:

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

filterConfiguration

default GameSessionQueue.Builder filterConfiguration(Consumer<FilterConfiguration.Builder> 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.

This is a convenience method that creates an instance of the FilterConfiguration.Builder avoiding the need to create one manually via FilterConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterConfiguration(FilterConfiguration).

Parameters:

filterConfiguration - a consumer that will call methods on FilterConfiguration.Builder

Returns:

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

See Also:

filterConfiguration(FilterConfiguration)

priorityConfiguration

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

Parameters:

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:

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

priorityConfiguration

default GameSessionQueue.Builder priorityConfiguration(Consumer<PriorityConfiguration.Builder> 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.

This is a convenience method that creates an instance of the PriorityConfiguration.Builder avoiding the need to create one manually via PriorityConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to priorityConfiguration(PriorityConfiguration).

Parameters:

priorityConfiguration - a consumer that will call methods on PriorityConfiguration.Builder

Returns:

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

See Also:

priorityConfiguration(PriorityConfiguration)

customEventData

GameSessionQueue.Builder customEventData(String customEventData)

Information that is added to all events that are related to this game session queue.

Parameters:

customEventData - Information that is added to all events that are related to this game session queue.

Returns:

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

notificationTarget

GameSessionQueue.Builder notificationTarget(String notificationTarget)

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Parameters:

notificationTarget - An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Returns:

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