Package 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("software.amazon.awssdk:codegen")
public final class DescribeGameSessionsRequest
extends GameLiftRequest
implements ToCopyableBuilder<DescribeGameSessionsRequest.Builder,DescribeGameSessionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeGameSessionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aliasId()	A unique identifier for the alias associated with the fleet to retrieve game sessions for.
static DescribeGameSessionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId()	A unique identifier for the fleet to retrieve game sessions for.
String	gameSessionId()	A unique identifier for the game session to retrieve.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of results to return.
String	location()	A fleet location to get game sessions for.
String	nextToken()	A 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()	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

fleetId

public final String fleetId()

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

Returns:

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

gameSessionId

public final String gameSessionId()

A unique identifier for the game session to retrieve.

Returns:

A unique identifier for the game session to retrieve.

aliasId

public final String aliasId()

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

Returns:

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

location

public final String location()

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

Returns:

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

statusFilter

public final String statusFilter()

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

Returns:

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

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.

Returns:

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

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.

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.

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