Interface DescribeGameSessionDetailsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<DescribeGameSessionDetailsRequest.Builder,,DescribeGameSessionDetailsRequest> GameLiftRequest.Builder,SdkBuilder<DescribeGameSessionDetailsRequest.Builder,,DescribeGameSessionDetailsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
DescribeGameSessionDetailsRequest
-
Method Summary
Modifier and TypeMethodDescriptionA unique identifier for the alias associated with the fleet to retrieve all game sessions for.A unique identifier for the fleet to retrieve all game sessions active on the fleet.gameSessionId(String gameSessionId) A unique identifier for the game session to retrieve.The maximum number of results to return.A fleet location to get game session details for.A token that indicates the start of the next sequential page of results.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.statusFilter(String statusFilter) Game session status to filter results on.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
fleetId
A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
- Parameters:
fleetId- A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionId
A unique identifier for the game session to retrieve.
- Parameters:
gameSessionId- A unique identifier for the game session to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aliasId
A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
- Parameters:
aliasId- A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
location
A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2.- Parameters:
location- A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such asus-west-2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusFilter
Game session status to filter results on. Possible game session statuses include
ACTIVE,TERMINATED,ACTIVATINGandTERMINATING(the last two are transitory).- Parameters:
statusFilter- Game session status to filter results on. Possible game session statuses includeACTIVE,TERMINATED,ACTIVATINGandTERMINATING(the last two are transitory).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limit
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.- Parameters:
limit- The maximum number of results to return. Use this parameter withNextTokento get results as a set of sequential pages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
- Parameters:
nextToken- A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeGameSessionDetailsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeGameSessionDetailsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-