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

Class ListGameServersRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListGameServersRequest.Builder,ListGameServersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListGameServersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListGameServersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupName()	An identifier for the game server group to retrieve a list of game servers from.
<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.
List<SdkField<?>>	sdkFields()
static Class<? extends ListGameServersRequest.Builder>	serializableBuilderClass()
SortOrder	sortOrder()	Indicates how to sort the returned data based on game server registration timestamp.
String	sortOrderAsString()	Indicates how to sort the returned data based on game server registration timestamp.
ListGameServersRequest.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

gameServerGroupName

public final String gameServerGroupName()

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Returns:

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

sortOrder

public final SortOrder sortOrder()

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

See Also:

SortOrder

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 ListGameServersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListGameServersRequest.Builder,ListGameServersRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static ListGameServersRequest.Builder builder()

serializableBuilderClass

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