software.amazon.awssdk.services.gamelift.model

Interface CreateMatchmakingConfigurationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateMatchmakingConfigurationRequest.Builder,CreateMatchmakingConfigurationRequest>, GameLiftRequest.Builder, SdkBuilder<CreateMatchmakingConfigurationRequest.Builder,CreateMatchmakingConfigurationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateMatchmakingConfigurationRequest

public static interface CreateMatchmakingConfigurationRequest.Builder
extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<CreateMatchmakingConfigurationRequest.Builder,CreateMatchmakingConfigurationRequest>

Method Summary

Modifier and Type	Method and Description
CreateMatchmakingConfigurationRequest.Builder	acceptanceRequired(Boolean acceptanceRequired) Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players.
CreateMatchmakingConfigurationRequest.Builder	acceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds) Length of time (in seconds) to wait for players to accept a proposed match.
CreateMatchmakingConfigurationRequest.Builder	additionalPlayerCount(Integer additionalPlayerCount) Number of player slots in a match to keep open for future players.
CreateMatchmakingConfigurationRequest.Builder	customEventData(String customEventData) Information to attached to all events related to the matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	description(String description) Meaningful description of the matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	gameProperties(Collection<GameProperty> gameProperties) Set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest.Builder	gameProperties(Consumer<GameProperty.Builder>... gameProperties) Set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest.Builder	gameProperties(GameProperty... gameProperties) Set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest.Builder	gameSessionData(String gameSessionData) Set of custom game session properties, formatted as a single string value.
CreateMatchmakingConfigurationRequest.Builder	gameSessionQueueArns(Collection<String> gameSessionQueueArns) Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it.
CreateMatchmakingConfigurationRequest.Builder	gameSessionQueueArns(String... gameSessionQueueArns) Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it.
CreateMatchmakingConfigurationRequest.Builder	name(String name) Unique identifier for a matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	notificationTarget(String notificationTarget) SNS topic ARN that is set up to receive matchmaking notifications.
CreateMatchmakingConfigurationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateMatchmakingConfigurationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateMatchmakingConfigurationRequest.Builder	requestTimeoutSeconds(Integer requestTimeoutSeconds) Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
CreateMatchmakingConfigurationRequest.Builder	ruleSetName(String ruleSetName) Unique identifier for a matchmaking rule set to use with this configuration.

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

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CreateMatchmakingConfigurationRequest.Builder name(String name)

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Parameters:

name - Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

Returns:

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

description

CreateMatchmakingConfigurationRequest.Builder description(String description)

Meaningful description of the matchmaking configuration.

Parameters:

description - Meaningful description of the matchmaking configuration.

Returns:

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

gameSessionQueueArns

CreateMatchmakingConfigurationRequest.Builder gameSessionQueueArns(Collection<String> gameSessionQueueArns)

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Parameters:

gameSessionQueueArns - Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Returns:

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

gameSessionQueueArns

CreateMatchmakingConfigurationRequest.Builder gameSessionQueueArns(String... gameSessionQueueArns)

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Parameters:

gameSessionQueueArns - Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Returns:

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

requestTimeoutSeconds

CreateMatchmakingConfigurationRequest.Builder requestTimeoutSeconds(Integer requestTimeoutSeconds)

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

Parameters:

requestTimeoutSeconds - Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

Returns:

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

acceptanceTimeoutSeconds

CreateMatchmakingConfigurationRequest.Builder acceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

Parameters:

acceptanceTimeoutSeconds - Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

Returns:

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

acceptanceRequired

CreateMatchmakingConfigurationRequest.Builder acceptanceRequired(Boolean acceptanceRequired)

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Parameters:

acceptanceRequired - Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Returns:

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

ruleSetName

CreateMatchmakingConfigurationRequest.Builder ruleSetName(String ruleSetName)

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

Parameters:

ruleSetName - Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

Returns:

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

notificationTarget

CreateMatchmakingConfigurationRequest.Builder notificationTarget(String notificationTarget)

SNS topic ARN that is set up to receive matchmaking notifications.

Parameters:

notificationTarget - SNS topic ARN that is set up to receive matchmaking notifications.

Returns:

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

additionalPlayerCount

CreateMatchmakingConfigurationRequest.Builder additionalPlayerCount(Integer additionalPlayerCount)

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Parameters:

additionalPlayerCount - Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Returns:

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

customEventData

CreateMatchmakingConfigurationRequest.Builder customEventData(String customEventData)

Information to attached to all events related to the matchmaking configuration.

Parameters:

customEventData - Information to attached to all events related to the matchmaking configuration.

Returns:

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

gameProperties

CreateMatchmakingConfigurationRequest.Builder gameProperties(Collection<GameProperty> gameProperties)

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Parameters:

gameProperties - Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Returns:

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

gameProperties

CreateMatchmakingConfigurationRequest.Builder gameProperties(GameProperty... gameProperties)

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Parameters:

gameProperties - Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Returns:

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

gameProperties

CreateMatchmakingConfigurationRequest.Builder gameProperties(Consumer<GameProperty.Builder>... gameProperties)

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

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 #gameProperties(List).

Parameters:

gameProperties - 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:

#gameProperties(List)

gameSessionData

CreateMatchmakingConfigurationRequest.Builder gameSessionData(String gameSessionData)

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Parameters:

gameSessionData - Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

Returns:

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

overrideConfiguration

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

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