public static interface DescribePlayerSessionsRequest.Builder extends GameLiftRequest.Builder, CopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>
Modifier and Type | Method and 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.
|
DescribePlayerSessionsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
DescribePlayerSessionsRequest.Builder gameSessionId(String gameSessionId)
Unique identifier for the game session to retrieve player sessions for.
gameSessionId
- Unique identifier for the game session to retrieve player sessions for.DescribePlayerSessionsRequest.Builder playerId(String playerId)
Unique identifier for a player to retrieve player sessions for.
playerId
- Unique identifier for a player to retrieve player sessions for.DescribePlayerSessionsRequest.Builder playerSessionId(String playerSessionId)
Unique identifier for a player session to retrieve.
playerSessionId
- 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)
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
- 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)
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. If a player session ID is specified, this parameter is ignored.
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. If a player session ID is specified, this parameter is ignored.DescribePlayerSessionsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.