@Generated(value="software.amazon.awssdk:codegen") public final class DescribePlayerSessionsRequest extends GameLiftRequest implements ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribePlayerSessionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribePlayerSessionsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
String |
gameSessionId()
Unique identifier for the game session to retrieve player sessions for.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
limit()
Maximum number of results to return.
|
String |
nextToken()
Token that indicates the start of the next sequential page of results.
|
String |
playerId()
Unique identifier for a player to retrieve player sessions for.
|
String |
playerSessionId()
Unique identifier for a player session to retrieve.
|
String |
playerSessionStatusFilter()
Player session status to filter results on.
|
static Class<? extends DescribePlayerSessionsRequest.Builder> |
serializableBuilderClass() |
DescribePlayerSessionsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String gameSessionId()
Unique identifier for the game session to retrieve player sessions for.
public String playerId()
Unique identifier for a player to retrieve player sessions for.
public String playerSessionId()
Unique identifier for a player session to retrieve.
public 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).
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).
public 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.
NextToken
to get results as a
set of sequential pages. If a player session ID is specified, this parameter is ignored.public 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.
public DescribePlayerSessionsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>
toBuilder
in class GameLiftRequest
public static DescribePlayerSessionsRequest.Builder builder()
public static Class<? extends DescribePlayerSessionsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.