public static interface DescribePlayerSessionsRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribePlayerSessionsRequest.Builder gameSessionId(String gameSessionId)
A unique identifier for the game session to retrieve player sessions for.
gameSessionId - A unique identifier for the game session to retrieve player sessions for.DescribePlayerSessionsRequest.Builder playerId(String playerId)
A unique identifier for a player to retrieve player sessions for.
playerId - A unique identifier for a player to retrieve player sessions for.DescribePlayerSessionsRequest.Builder playerSessionId(String playerSessionId)
A unique identifier for a player session to retrieve.
playerSessionId - A unique identifier for a player session to retrieve.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 timeout limit (60 seconds).
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 timeout limit (60 seconds).
DescribePlayerSessionsRequest.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. If a player session ID is specified, this parameter is ignored.
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.DescribePlayerSessionsRequest.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. If a player session ID is specified, this parameter is ignored.
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.DescribePlayerSessionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderDescribePlayerSessionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.