software.amazon.awssdk.services.gamelift.model

Interface DescribeGameSessionsRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeGameSessionsRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeGameSessionsRequest.Builder	aliasId(String aliasId) Unique identifier for an alias associated with the fleet to retrieve all game sessions for.
DescribeGameSessionsRequest.Builder	fleetId(String fleetId) Unique identifier for a fleet to retrieve all game sessions for.
DescribeGameSessionsRequest.Builder	gameSessionId(String gameSessionId) Unique identifier for the game session to retrieve.
DescribeGameSessionsRequest.Builder	limit(Integer limit) Maximum number of results to return.
DescribeGameSessionsRequest.Builder	nextToken(String nextToken) Token that indicates the start of the next sequential page of results.
DescribeGameSessionsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeGameSessionsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

fleetId

DescribeGameSessionsRequest.Builder fleetId(String fleetId)

Unique identifier for a fleet to retrieve all game sessions for.

Parameters:

fleetId - Unique identifier for a fleet to retrieve all game sessions for.

Returns:

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

gameSessionId

DescribeGameSessionsRequest.Builder gameSessionId(String gameSessionId)

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Parameters:

gameSessionId - Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Returns:

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

aliasId

DescribeGameSessionsRequest.Builder aliasId(String aliasId)

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Parameters:

aliasId - Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

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. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Parameters:

statusFilter - Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Returns:

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

limit

DescribeGameSessionsRequest.Builder limit(Integer limit)

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

Parameters:

limit - 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)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Parameters:

nextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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.

requestOverrideConfig

DescribeGameSessionsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeGameSessionsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.