Interface ClaimGameServerRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ClaimGameServerRequest.Builder,ClaimGameServerRequest>,GameLiftRequest.Builder,SdkBuilder<ClaimGameServerRequest.Builder,ClaimGameServerRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ClaimGameServerRequest
public static interface ClaimGameServerRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<ClaimGameServerRequest.Builder,ClaimGameServerRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ClaimGameServerRequest.BuilderfilterOption(Consumer<ClaimFilterOption.Builder> filterOption)Object that restricts how a claimed game server is chosen.ClaimGameServerRequest.BuilderfilterOption(ClaimFilterOption filterOption)Object that restricts how a claimed game server is chosen.ClaimGameServerRequest.BuildergameServerData(String gameServerData)A set of custom game server properties, formatted as a single string value.ClaimGameServerRequest.BuildergameServerGroupName(String gameServerGroupName)A unique identifier for the game server group where the game server is running.ClaimGameServerRequest.BuildergameServerId(String gameServerId)A custom string that uniquely identifies the game server to claim.ClaimGameServerRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ClaimGameServerRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
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 Detail
-
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 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 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 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 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 theClaimFilterOption.Builderavoiding the need to create one manually viaClaimFilterOption.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilterOption(ClaimFilterOption).- Parameters:
filterOption- a consumer that will call methods onClaimFilterOption.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filterOption(ClaimFilterOption)
-
overrideConfiguration
ClaimGameServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ClaimGameServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-