software.amazon.awssdk.services.gamelift.model

Interface ListAliasesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>, GameLiftRequest.Builder, SdkBuilder<ListAliasesRequest.Builder,ListAliasesRequest>, SdkRequest.Builder

Enclosing class:

ListAliasesRequest

public static interface ListAliasesRequest.Builder
extends GameLiftRequest.Builder, CopyableBuilder<ListAliasesRequest.Builder,ListAliasesRequest>

Method Summary

Modifier and Type	Method and Description
ListAliasesRequest.Builder	limit(Integer limit) Maximum number of results to return.
ListAliasesRequest.Builder	name(String name) Descriptive label that is associated with an alias.
ListAliasesRequest.Builder	nextToken(String nextToken) Token that indicates the start of the next sequential page of results.
ListAliasesRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
ListAliasesRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
ListAliasesRequest.Builder	routingStrategyType(RoutingStrategyType routingStrategyType) Type of routing to filter results on.
ListAliasesRequest.Builder	routingStrategyType(String routingStrategyType) Type of routing to filter results on.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

routingStrategyType

ListAliasesRequest.Builder routingStrategyType(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, RoutingStrategyType

routingStrategyType

ListAliasesRequest.Builder routingStrategyType(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, RoutingStrategyType

name

ListAliasesRequest.Builder name(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.

limit

ListAliasesRequest.Builder limit(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.

nextToken

ListAliasesRequest.Builder nextToken(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.

requestOverrideConfig

ListAliasesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

ListAliasesRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.