Interface StartMatchmakingRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartMatchmakingRequest.Builder,
,StartMatchmakingRequest> GameLiftRequest.Builder
,SdkBuilder<StartMatchmakingRequest.Builder,
,StartMatchmakingRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartMatchmakingRequest
-
Method Summary
Modifier and TypeMethodDescriptionconfigurationName
(String configurationName) Name of the matchmaking configuration to use for this request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.players
(Collection<Player> players) Information on each player to be matched.players
(Consumer<Player.Builder>... players) Information on each player to be matched.Information on each player to be matched.A unique identifier for a matchmaking ticket.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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 aStartMatchmaking
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 aStartMatchmaking
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 aStartMatchmaking
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 aStartMatchmaking
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of thePlayers
in aStartMatchmaking
request.Player.Builder
avoiding the need to create one manually viaPlayer.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplayers(List<Player>)
.- Parameters:
players
- a consumer that will call methods onPlayer.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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-