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

Interface MatchmakingConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MatchmakingConfiguration.Builder,MatchmakingConfiguration>, SdkBuilder<MatchmakingConfiguration.Builder,MatchmakingConfiguration>, SdkPojo
Enclosing class:
MatchmakingConfiguration
public static interface MatchmakingConfiguration.Builder extends SdkPojo, CopyableBuilder<MatchmakingConfiguration.Builder,MatchmakingConfiguration>

  • Method Details

    • name

      MatchmakingConfiguration.Builder name(String name)

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

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

    • configurationArn

      MatchmakingConfiguration.Builder configurationArn(String configurationArn)

      The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name> . In a Amazon GameLift configuration ARN, the resource ID matches the Name value.

      Parameters:
      configurationArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name> . In a Amazon GameLift configuration ARN, the resource ID matches the Name value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      MatchmakingConfiguration.Builder description(String description)

      A descriptive label that is associated with matchmaking configuration.

      Parameters:
      description - A descriptive label that is associated with matchmaking configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameSessionQueueArns

      MatchmakingConfiguration.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. This property is not set when FlexMatchMode is set to STANDALONE.

      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. This property is not set when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameSessionQueueArns

      MatchmakingConfiguration.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. This property is not set when FlexMatchMode is set to STANDALONE.

      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. This property is not set when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestTimeoutSeconds

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

      MatchmakingConfiguration.Builder acceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds)

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

      Parameters:
      acceptanceTimeoutSeconds - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. 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

      MatchmakingConfiguration.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. When this option is 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. When this option is 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

      MatchmakingConfiguration.Builder ruleSetName(String ruleSetName)

      A unique identifier for the 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 - A unique identifier for the 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.

    • ruleSetArn

      MatchmakingConfiguration.Builder ruleSetArn(String ruleSetArn)

      The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

      Parameters:
      ruleSetArn - The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationTarget

      MatchmakingConfiguration.Builder notificationTarget(String notificationTarget)

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

      Parameters:
      notificationTarget - An 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

      MatchmakingConfiguration.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 when 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 when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customEventData

      MatchmakingConfiguration.Builder customEventData(String customEventData)

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

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

    • creationTime

      MatchmakingConfiguration.Builder creationTime(Instant creationTime)

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      Parameters:
      creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

      MatchmakingConfiguration.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 when 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 when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

      MatchmakingConfiguration.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 when 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 when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameProperties

      MatchmakingConfiguration.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 when 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

      MatchmakingConfiguration.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 new GameSession object that is created for a successful match. This parameter is not used when 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 new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backfillMode

      MatchmakingConfiguration.Builder backfillMode(String backfillMode)

      The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests 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 used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests 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

      MatchmakingConfiguration.Builder backfillMode(BackfillMode backfillMode)

      The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests 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 used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests 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

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

      MatchmakingConfiguration.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: