Class ListAliasesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.gamelift.model.ListAliasesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListAliasesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input for a request action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListAliasesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListAliasesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Integer
getLimit()
Maximum number of results to return.String
getName()
Descriptive label associated with this alias.String
getNextToken()
Token indicating 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 associated with this alias.void
setNextToken(String nextToken)
Token indicating 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 associated with this alias.ListAliasesRequest
withNextToken(String nextToken)
Token indicating 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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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:
- 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:- 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:
- 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:
- 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:
- 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:- 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:
- 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:- 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:
- 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:- 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 associated with this alias. Alias names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this alias. Alias names do not need to be unique.
-
getName
public String getName()
Descriptive label associated with this alias. Alias names do not need to be unique.
- Returns:
- Descriptive label associated with this alias. Alias names do not need to be unique.
-
withName
public ListAliasesRequest withName(String name)
Descriptive label associated with this alias. Alias names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this 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. You can use this parameter with NextToken to get results as a set of sequential pages.
- Parameters:
limit
- Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
-
getLimit
public Integer getLimit()
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
- Returns:
- Maximum number of results to return. You can 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. You can use this parameter with NextToken to get results as a set of sequential pages.
- Parameters:
limit
- Maximum number of results to return. You can 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 indicating 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.
- Parameters:
nextToken
- Token indicating 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.
-
getNextToken
public String getNextToken()
Token indicating 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 indicating 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.
-
withNextToken
public ListAliasesRequest withNextToken(String nextToken)
Token indicating 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.
- Parameters:
nextToken
- Token indicating 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:
- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ListAliasesRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-