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

Class DescribePlayerSessionsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribePlayerSessionsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePlayerSessionsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribePlayerSessionsRequest.Builder	builder()
boolean	equals(Object obj)
String	gameSessionId()	Unique identifier for the game session to retrieve player sessions for.
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

gameSessionId

public String gameSessionId()

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

Returns:

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

playerId

public String playerId()

Unique identifier for a player to retrieve player sessions for.

Returns:

Unique identifier for a player to retrieve player sessions for.

playerSessionId

public String playerSessionId()

Unique identifier for a player session to retrieve.

Returns:

Unique identifier for a player session to retrieve.

playerSessionStatusFilter

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 time-out limit (60 seconds).

Returns:

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).

limit

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.

Returns:

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

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

Returns:

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.

toBuilder

public DescribePlayerSessionsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

Returns:

a builder for type T

builder

public static DescribePlayerSessionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribePlayerSessionsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object