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

Interface StartMatchBackfillRequest.Builder

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

  • Method Details

    • ticketId

      StartMatchBackfillRequest.Builder ticketId(String ticketId)

      A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

      Parameters:
      ticketId - A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationName

      StartMatchBackfillRequest.Builder configurationName(String configurationName)

      Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

      Parameters:
      configurationName - Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameSessionArn

      StartMatchBackfillRequest.Builder gameSessionArn(String gameSessionArn)

      A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

      Parameters:
      gameSessionArn - A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • players

      StartMatchBackfillRequest.Builder players(Collection<Player> players)

      Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

      You can include up to 199 Players in a StartMatchBackfill request.

      • PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

        The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

      • LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

      Parameters:
      players - Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

      You can include up to 199 Players in a StartMatchBackfill request.

      • PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

        The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

      • LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

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

    • players

      StartMatchBackfillRequest.Builder players(Player... players)

      Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

      You can include up to 199 Players in a StartMatchBackfill request.

      • PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

        The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

      • LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

      Parameters:
      players - Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

      You can include up to 199 Players in a StartMatchBackfill request.

      • PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

        The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

      • LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

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

    • players

      StartMatchBackfillRequest.Builder players(Consumer<Player.Builder>... players)

      Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

      You can include up to 199 Players in a StartMatchBackfill request.

      • PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

        The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.

      • LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

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

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

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

    • overrideConfiguration

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

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