software.amazon.awssdk.services.gamelift.model

Interface StartMatchmakingRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>, GameLiftRequest.Builder, SdkBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>, SdkRequest.Builder

Enclosing class:

StartMatchmakingRequest

public static interface StartMatchmakingRequest.Builder
extends GameLiftRequest.Builder, CopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>

Method Summary

Modifier and Type	Method and Description
StartMatchmakingRequest.Builder	configurationName(String configurationName) Name of the matchmaking configuration to use for this request.
StartMatchmakingRequest.Builder	players(Collection<Player> players) Information on each player to be matched.
StartMatchmakingRequest.Builder	players(Consumer<Player.Builder>... players) Information on each player to be matched.
StartMatchmakingRequest.Builder	players(Player... players) Information on each player to be matched.
StartMatchmakingRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
StartMatchmakingRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
StartMatchmakingRequest.Builder	ticketId(String ticketId) Unique identifier for a matchmaking ticket.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

ticketId

StartMatchmakingRequest.Builder ticketId(String ticketId)

Unique identifier for a matchmaking ticket. Use this identifier to track the matchmaking ticket status and retrieve match results.

Parameters:

ticketId - Unique identifier for a matchmaking ticket. 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.

Parameters:

configurationName - Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

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.

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.

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.

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.

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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #players(List).

Parameters:

players - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#players(List)

requestOverrideConfig

StartMatchmakingRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

StartMatchmakingRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.