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

Interface UpdateMatchmakingConfigurationRequest.Builder

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

  • Method Details

    • name

      UpdateMatchmakingConfigurationRequest.Builder name(String name)

      A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.

      Parameters:
      name - A unique identifier for the matchmaking configuration to update. 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.

    • description

      UpdateMatchmakingConfigurationRequest.Builder description(String description)

      A description for the matchmaking configuration.

      Parameters:
      description - A description for the matchmaking configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameSessionQueueArns

      UpdateMatchmakingConfigurationRequest.Builder gameSessionQueueArns(Collection<String> gameSessionQueueArns)

      The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

      Parameters:
      gameSessionQueueArns - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameSessionQueueArns

      UpdateMatchmakingConfigurationRequest.Builder gameSessionQueueArns(String... gameSessionQueueArns)

      The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

      Parameters:
      gameSessionQueueArns - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestTimeoutSeconds

      UpdateMatchmakingConfigurationRequest.Builder requestTimeoutSeconds(Integer requestTimeoutSeconds)

      The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

      Parameters:
      requestTimeoutSeconds - The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptanceTimeoutSeconds

      UpdateMatchmakingConfigurationRequest.Builder acceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)

      The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

      Parameters:
      acceptanceTimeoutSeconds - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptanceRequired

      UpdateMatchmakingConfigurationRequest.Builder acceptanceRequired(Boolean acceptanceRequired)

      A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

      Parameters:
      acceptanceRequired - A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleSetName

      UpdateMatchmakingConfigurationRequest.Builder ruleSetName(String ruleSetName)

      A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

      Parameters:
      ruleSetName - A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. 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

      UpdateMatchmakingConfigurationRequest.Builder notificationTarget(String notificationTarget)

      An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

      Parameters:
      notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalPlayerCount

      UpdateMatchmakingConfigurationRequest.Builder additionalPlayerCount(Integer additionalPlayerCount)

      The 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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if FlexMatchMode is set to STANDALONE.

      Parameters:
      additionalPlayerCount - The 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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customEventData

      UpdateMatchmakingConfigurationRequest.Builder customEventData(String customEventData)

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

      Parameters:
      customEventData - Information to add to all events related to the matchmaking configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

      UpdateMatchmakingConfigurationRequest.Builder gameProperties(Collection<GameProperty> gameProperties)

      A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

      Parameters:
      gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

      UpdateMatchmakingConfigurationRequest.Builder gameProperties(GameProperty... gameProperties)

      A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

      Parameters:
      gameProperties - A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

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

      A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

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

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

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

    • gameSessionData

      UpdateMatchmakingConfigurationRequest.Builder gameSessionData(String gameSessionData)

      A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

      Parameters:
      gameSessionData - A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backfillMode

      UpdateMatchmakingConfigurationRequest.Builder backfillMode(String backfillMode)

      The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

      Parameters:
      backfillMode - The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • backfillMode

      UpdateMatchmakingConfigurationRequest.Builder backfillMode(BackfillMode backfillMode)

      The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

      Parameters:
      backfillMode - The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • flexMatchMode

      UpdateMatchmakingConfigurationRequest.Builder flexMatchMode(String flexMatchMode)

      Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

      • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

      • WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

      Parameters:
      flexMatchMode - Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

      • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

      • WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

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

    • flexMatchMode

      UpdateMatchmakingConfigurationRequest.Builder flexMatchMode(FlexMatchMode flexMatchMode)

      Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

      • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

      • WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

      Parameters:
      flexMatchMode - Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

      • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

      • WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

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

    • overrideConfiguration

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

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