Interface StartMatchmakingRequest.Builder

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

  • Method Details

    • ticketId

      StartMatchmakingRequest.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 matchmaking 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 matchmaking ticket status and retrieve match results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationName

      StartMatchmakingRequest.Builder configurationName(String configurationName)

      Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

      Parameters:
      configurationName - Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • players

      StartMatchmakingRequest.Builder players(Collection<Player> players)

      Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

      You can include up to 10 Players in a StartMatchmaking request.

      Parameters:
      players - Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

      You can include up to 10 Players in a StartMatchmaking request.

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

    • players

      StartMatchmakingRequest.Builder players(Player... players)

      Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

      You can include up to 10 Players in a StartMatchmaking request.

      Parameters:
      players - Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

      You can include up to 10 Players in a StartMatchmaking request.

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

    • players

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

      Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

      You can include up to 10 Players in a StartMatchmaking request.

      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

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

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