software.amazon.awssdk.services.gamelift.model

Class DescribeGameSessionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGameSessionsRequest.Builder,DescribeGameSessionsRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeGameSessionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	aliasId() Unique identifier for an alias associated with the fleet to retrieve all game sessions for.
static DescribeGameSessionsRequest.Builder	builder()
boolean	equals(Object obj)
String	fleetId() Unique identifier for a fleet to retrieve all game sessions for.
String	gameSessionId() Unique identifier for the game session to retrieve.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() Maximum number of results to return.
String	nextToken() Token that indicates the start of the next sequential page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGameSessionsRequest.Builder>	serializableBuilderClass()
String	statusFilter() Game session status to filter results on.
DescribeGameSessionsRequest.Builder	toBuilder()
String	toString()

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

fleetId

public String fleetId()

Unique identifier for a fleet to retrieve all game sessions for.

Returns:

Unique identifier for a fleet to retrieve all game sessions for.

gameSessionId

public String gameSessionId()

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

Returns:

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

aliasId

public String aliasId()

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Returns:

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

statusFilter

public String statusFilter()

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

Returns:

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

limit

public Integer limit()

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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 start at the beginning of the result set, do not specify a value.

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 start at the beginning of the result set, do not specify a value.

toBuilder

public DescribeGameSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGameSessionsRequest.Builder,DescribeGameSessionsRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static DescribeGameSessionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeGameSessionsRequest.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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo