Package software.amazon.awssdk.services.gamelift.model

Interface DescribePlayerSessionsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>, SdkBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

Enclosing class:

DescribePlayerSessionsRequest

public static interface DescribePlayerSessionsRequest.Builder
extends CopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

Method Summary

Modifier and Type	Method	Description
DescribePlayerSessionsRequest.Builder	gameSessionId(String gameSessionId)	Unique identifier for the game session to retrieve player sessions for.
DescribePlayerSessionsRequest.Builder	limit(Integer limit)	Maximum number of results to return.
DescribePlayerSessionsRequest.Builder	nextToken(String nextToken)	Token that indicates the start of the next sequential page of results.
DescribePlayerSessionsRequest.Builder	playerId(String playerId)	Unique identifier for a player to retrieve player sessions for.
DescribePlayerSessionsRequest.Builder	playerSessionId(String playerSessionId)	Unique identifier for a player session to retrieve.
DescribePlayerSessionsRequest.Builder	playerSessionStatusFilter(String playerSessionStatusFilter)	Player session status to filter results on.

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

gameSessionId

DescribePlayerSessionsRequest.Builder gameSessionId(String gameSessionId)

Unique identifier for the game session to retrieve player sessions for.

Parameters:

gameSessionId - Unique identifier for the game session to retrieve player sessions for.

Returns:

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

playerId

DescribePlayerSessionsRequest.Builder playerId(String playerId)

Unique identifier for a player to retrieve player sessions for.

Parameters:

playerId - Unique identifier for a player to retrieve player sessions for.

Returns:

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

playerSessionId

DescribePlayerSessionsRequest.Builder playerSessionId(String playerSessionId)

Unique identifier for a player session to retrieve.

Parameters:

playerSessionId - Unique identifier for a player session to retrieve.

Returns:

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

playerSessionStatusFilter

DescribePlayerSessionsRequest.Builder playerSessionStatusFilter(String playerSessionStatusFilter)

Player session status to filter results on.

Possible player session statuses include the following:

• RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

• ACTIVE – The player has been validated by the server process and is currently connected.

• COMPLETED – The player connection has been dropped.

• TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).

Parameters:

playerSessionStatusFilter - Player session status to filter results on.

Possible player session statuses include the following:

• RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

• ACTIVE – The player has been validated by the server process and is currently connected.

• COMPLETED – The player connection has been dropped.

• TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).

Returns:

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

limit

DescribePlayerSessionsRequest.Builder limit(Integer limit)

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Parameters:

limit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

Returns:

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

nextToken

DescribePlayerSessionsRequest.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 specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

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 specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

Returns:

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