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

Interface UpdateGameSessionQueueRequest.Builder

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

  • Method Details

    • name

      UpdateGameSessionQueueRequest.Builder name(String name)

      A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

      Parameters:
      name - A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutInSeconds

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

      UpdateGameSessionQueueRequest.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. When updating policies, provide a complete collection of policies.

      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. When updating policies, provide a complete collection of policies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playerLatencyPolicies

      UpdateGameSessionQueueRequest.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. When updating policies, provide a complete collection of policies.

      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. When updating policies, provide a complete collection of policies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playerLatencyPolicies

      UpdateGameSessionQueueRequest.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. When updating policies, provide a complete collection of policies.

      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

      UpdateGameSessionQueueRequest.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. When updating this list, provide a complete list of destinations.

      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. When updating this list, provide a complete list of destinations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinations

      UpdateGameSessionQueueRequest.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. When updating this list, provide a complete list of destinations.

      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. When updating this list, provide a complete list of destinations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinations

      UpdateGameSessionQueueRequest.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. When updating this list, provide a complete list of destinations.

      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

      UpdateGameSessionQueueRequest.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. To remove an existing filter configuration, pass in an empty set.

      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. To remove an existing filter configuration, pass in an empty set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterConfiguration

      default UpdateGameSessionQueueRequest.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. To remove an existing filter configuration, pass in an empty set.

      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

      UpdateGameSessionQueueRequest.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. To remove an existing priority configuration, pass in an empty set.

      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. To remove an existing priority configuration, pass in an empty set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priorityConfiguration

      default UpdateGameSessionQueueRequest.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. To remove an existing priority configuration, pass in an empty set.

      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

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

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

    • overrideConfiguration

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

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