software.amazon.awssdk.services.gamelift.model

Class ListAliasesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAliasesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListAliasesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() Maximum number of results to return.
String	name() Descriptive label that is associated with an alias.
String	nextToken() Token that indicates the start of the next sequential page of results.
RoutingStrategyType	routingStrategyType() Type of routing to filter results on.
String	routingStrategyTypeAsString() Type of routing to filter results on.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAliasesRequest.Builder>	serializableBuilderClass()
ListAliasesRequest.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

routingStrategyType

public RoutingStrategyType routingStrategyType()

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

• SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

• TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

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

Returns:

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

• SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

• TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

See Also:

RoutingStrategyType

routingStrategyTypeAsString

public String routingStrategyTypeAsString()

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

• SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

• TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

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

Returns:

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

• SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

• TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

See Also:

RoutingStrategyType

name

public String name()

Descriptive label that is associated with an alias. Alias names do not need to be unique.

Returns:

Descriptive label that is associated with an alias. Alias names do not need to be unique.

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

Specified by:

toBuilder in interface ToCopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static ListAliasesRequest.Builder builder()

serializableBuilderClass

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