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

Class DescribePlayerSessionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePlayerSessionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribePlayerSessionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameSessionId()	A unique identifier for the game session to retrieve player sessions for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of results to return.
String	nextToken()	A token that indicates the start of the next sequential page of results.
String	playerId()	A unique identifier for a player to retrieve player sessions for.
String	playerSessionId()	A unique identifier for a player session to retrieve.
String	playerSessionStatusFilter()	Player session status to filter results on.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePlayerSessionsRequest.Builder>	serializableBuilderClass()
DescribePlayerSessionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

gameSessionId

public final String gameSessionId()

A unique identifier for the game session to retrieve player sessions for.

Returns:

A unique identifier for the game session to retrieve player sessions for.

playerId

public final String playerId()

A unique identifier for a player to retrieve player sessions for.

Returns:

A unique identifier for a player to retrieve player sessions for.

playerSessionId

public final String playerSessionId()

A unique identifier for a player session to retrieve.

Returns:

A unique identifier for a player session to retrieve.

playerSessionStatusFilter

public final String 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:

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

limit

public final 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.

Returns:

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.

nextToken

public final 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.

Returns:

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.

toBuilder

public DescribePlayerSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePlayerSessionsRequest.Builder,DescribePlayerSessionsRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static DescribePlayerSessionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo