@Generated(value="software.amazon.awssdk:codegen") public class ListAliasesRequest extends GameLiftRequest implements ToCopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>
Represents the input for a request action.
Modifier and Type | Class and Description |
---|---|
static interface |
ListAliasesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListAliasesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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 |
routingStrategyTypeString()
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() |
requestOverrideConfig
copy
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 routingStrategyTypeString()
.
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.
RoutingStrategyType
public String routingStrategyTypeString()
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 routingStrategyTypeString()
.
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.
RoutingStrategyType
public String name()
Descriptive label that is associated with an alias. Alias names do not need to be unique.
public Integer limit()
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of
sequential pages.
NextToken
to get results as a
set of sequential pages.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.
public ListAliasesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>
toBuilder
in class GameLiftRequest
public static ListAliasesRequest.Builder builder()
public static Class<? extends ListAliasesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.