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

Interface CreateGameSessionQueueRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>, GameLiftRequest.Builder, SdkBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGameSessionQueueRequest
public static interface CreateGameSessionQueueRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<CreateGameSessionQueueRequest.Builder,CreateGameSessionQueueRequest>

  • Method Details

    • name

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

    • timeoutInSeconds

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

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

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

      CreateGameSessionQueueRequest.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<PlayerLatencyPolicy>).

      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:

    • destinations

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

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

      CreateGameSessionQueueRequest.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<GameSessionQueueDestination>).

      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:

    • filterConfiguration

      CreateGameSessionQueueRequest.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 CreateGameSessionQueueRequest.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:

    • priorityConfiguration

      CreateGameSessionQueueRequest.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 CreateGameSessionQueueRequest.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:

    • customEventData

      CreateGameSessionQueueRequest.Builder customEventData(String customEventData)

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

      Parameters:
      customEventData - Information to be 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

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

    • tags

      CreateGameSessionQueueRequest.Builder tags(Collection<Tag> tags)

      A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

      Parameters:
      tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGameSessionQueueRequest.Builder tags(Tag... tags)

      A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

      Parameters:
      tags - A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGameSessionQueueRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateGameSessionQueueRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateGameSessionQueueRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.