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

Class ListAliasesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.gamelift.model.ListAliasesRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAliasesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ListAliasesRequest.Builder	builder()
boolean	equals(Object obj)
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.
String	routingStrategyType()	Type of routing to filter results on.
static Class<? extends ListAliasesRequest.Builder>	serializableBuilderClass()
ListAliasesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

routingStrategyType

public String 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.

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

toBuilder

public ListAliasesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>

Returns:

a builder for type T

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