Interface DescribePlayerSessionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribePlayerSessionsRequest.Builder,
,DescribePlayerSessionsRequest> GameLiftRequest.Builder
,SdkBuilder<DescribePlayerSessionsRequest.Builder,
,DescribePlayerSessionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribePlayerSessionsRequest
-
Method Summary
Modifier and TypeMethodDescriptiongameSessionId
(String gameSessionId) A unique identifier for the game session to retrieve player sessions for.The maximum number of results to return.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.A unique identifier for a player to retrieve player sessions for.playerSessionId
(String playerSessionId) A unique identifier for a player session to retrieve.playerSessionStatusFilter
(String playerSessionStatusFilter) Player session status to filter results on.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 Details
-
gameSessionId
A unique identifier for the game session to retrieve player sessions for.
- Parameters:
gameSessionId
- A 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
A unique identifier for a player to retrieve player sessions for.
- Parameters:
playerId
- A 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
A unique identifier for a player session to retrieve.
- Parameters:
playerSessionId
- A unique identifier for a player session to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playerSessionStatusFilter
Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
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 timeout limit (60 seconds).
- Parameters:
playerSessionStatusFilter
- Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.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 timeout limit (60 seconds).
-
- 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
NextToken
to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.- Parameters:
limit
- The maximum number of results to return. Use this parameter withNextToken
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
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. If a player session ID is specified, this parameter is ignored.
- 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. 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.
-
overrideConfiguration
DescribePlayerSessionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribePlayerSessionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-