software.amazon.awssdk.services.gamelift.model

Interface DescribeGameSessionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeGameSessionsRequest.Builder,DescribeGameSessionsRequest>, GameLiftRequest.Builder, SdkBuilder<DescribeGameSessionsRequest.Builder,DescribeGameSessionsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeGameSessionsRequest

public static interface DescribeGameSessionsRequest.Builder
extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<DescribeGameSessionsRequest.Builder,DescribeGameSessionsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeGameSessionsRequest.Builder	aliasId(String aliasId) A unique identifier for the alias associated with the fleet to retrieve game sessions for.
DescribeGameSessionsRequest.Builder	fleetId(String fleetId) A unique identifier for the fleet to retrieve game sessions for.
DescribeGameSessionsRequest.Builder	gameSessionId(String gameSessionId) A unique identifier for the game session to retrieve.
DescribeGameSessionsRequest.Builder	limit(Integer limit) The maximum number of results to return.
DescribeGameSessionsRequest.Builder	location(String location) A fleet location to get game sessions for.
DescribeGameSessionsRequest.Builder	nextToken(String nextToken) A token that indicates the start of the next sequential page of results.
DescribeGameSessionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeGameSessionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeGameSessionsRequest.Builder	statusFilter(String statusFilter) Game session status to filter results on.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

fleetId

DescribeGameSessionsRequest.Builder fleetId(String fleetId)

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

Parameters:

fleetId - A unique identifier for the fleet to retrieve game sessions for. 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

DescribeGameSessionsRequest.Builder gameSessionId(String 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

DescribeGameSessionsRequest.Builder aliasId(String aliasId)

A unique identifier for the alias associated with the fleet to retrieve 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 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

DescribeGameSessionsRequest.Builder location(String location)

A fleet location to get game sessions 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 sessions 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.

Returns:

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

statusFilter

DescribeGameSessionsRequest.Builder statusFilter(String statusFilter)

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

Parameters:

statusFilter - Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

Returns:

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

limit

DescribeGameSessionsRequest.Builder limit(Integer limit)

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Parameters:

limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

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

nextToken

DescribeGameSessionsRequest.Builder nextToken(String 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

DescribeGameSessionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeGameSessionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder