Interface ClaimGameServerRequest.Builder

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

  • Method Details

    • gameServerGroupName

      ClaimGameServerRequest.Builder gameServerGroupName(String gameServerGroupName)

      A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift Servers FleetIQ to look for an available game server to claim.

      Parameters:
      gameServerGroupName - A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift Servers FleetIQ to look for an available game server to claim.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameServerId

      ClaimGameServerRequest.Builder gameServerId(String gameServerId)

      A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift Servers FleetIQ searches for an available game server in the specified game server group.

      Parameters:
      gameServerId - A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift Servers FleetIQ searches for an available game server in the specified game server group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameServerData

      ClaimGameServerRequest.Builder gameServerData(String gameServerData)

      A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

      Parameters:
      gameServerData - A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterOption

      ClaimGameServerRequest.Builder filterOption(ClaimFilterOption filterOption)

      Object that restricts how a claimed game server is chosen.

      Parameters:
      filterOption - Object that restricts how a claimed game server is chosen.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterOption

      default ClaimGameServerRequest.Builder filterOption(Consumer<ClaimFilterOption.Builder> filterOption)

      Object that restricts how a claimed game server is chosen.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterOption(ClaimFilterOption).

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

    • overrideConfiguration

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

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