com.amazonaws.services.gamelift.model

Class ListAliasesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.ListAliasesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListAliasesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListAliasesRequest()

Method Summary

Modifier and Type	Method and Description
ListAliasesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getLimit() Maximum number of results to return.
String	getName() Descriptive label that is associated with an alias.
String	getNextToken() Token that indicates the start of the next sequential page of results.
String	getRoutingStrategyType() Type of routing to filter results on.
int	hashCode()
void	setLimit(Integer limit) Maximum number of results to return.
void	setName(String name) Descriptive label that is associated with an alias.
void	setNextToken(String nextToken) Token that indicates the start of the next sequential page of results.
void	setRoutingStrategyType(RoutingStrategyType routingStrategyType) Type of routing to filter results on.
void	setRoutingStrategyType(String routingStrategyType) Type of routing to filter results on.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListAliasesRequest	withLimit(Integer limit) Maximum number of results to return.
ListAliasesRequest	withName(String name) Descriptive label that is associated with an alias.
ListAliasesRequest	withNextToken(String nextToken) Token that indicates the start of the next sequential page of results.
ListAliasesRequest	withRoutingStrategyType(RoutingStrategyType routingStrategyType) Type of routing to filter results on.
ListAliasesRequest	withRoutingStrategyType(String routingStrategyType) Type of routing to filter results on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListAliasesRequest

public ListAliasesRequest()

Method Detail

setRoutingStrategyType

public void setRoutingStrategyType(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.

Parameters:

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.

See Also:

RoutingStrategyType

getRoutingStrategyType

public String getRoutingStrategyType()

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

withRoutingStrategyType

public ListAliasesRequest withRoutingStrategyType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

RoutingStrategyType

setRoutingStrategyType

public void setRoutingStrategyType(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.

Parameters:

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.

See Also:

RoutingStrategyType

withRoutingStrategyType

public ListAliasesRequest withRoutingStrategyType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

RoutingStrategyType

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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.

withName

public ListAliasesRequest withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLimit

public void setLimit(Integer limit)

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

Parameters:

limit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

getLimit

public Integer getLimit()

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.

withLimit

public ListAliasesRequest withLimit(Integer limit)

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

Parameters:

limit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public ListAliasesRequest withNextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListAliasesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()