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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAliasesRequest.Builder

Method Summary

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

routingStrategyType

public final RoutingStrategyType routingStrategyType()

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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:

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 final String routingStrategyTypeAsString()

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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:

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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 final String name()

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

Returns:

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

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