software.amazon.awssdk.services.robomaker.model

Interface ListRobotsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListRobotsRequest.Builder,ListRobotsRequest>, RoboMakerRequest.Builder, SdkBuilder<ListRobotsRequest.Builder,ListRobotsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListRobotsRequest

public static interface ListRobotsRequest.Builder
extends RoboMakerRequest.Builder, SdkPojo, CopyableBuilder<ListRobotsRequest.Builder,ListRobotsRequest>

Method Summary

Modifier and Type	Method and Description
ListRobotsRequest.Builder	filters(Collection<Filter> filters) Optional filters to limit results.
ListRobotsRequest.Builder	filters(Consumer<Filter.Builder>... filters) Optional filters to limit results.
ListRobotsRequest.Builder	filters(Filter... filters) Optional filters to limit results.
ListRobotsRequest.Builder	maxResults(Integer maxResults) The maximum number of deployment job results returned by ListRobots in paginated output.
ListRobotsRequest.Builder	nextToken(String nextToken) The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter.
ListRobotsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListRobotsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.robomaker.model.RoboMakerRequest.Builder

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

nextToken

ListRobotsRequest.Builder nextToken(String nextToken)

The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Parameters:

nextToken - The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

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

maxResults

ListRobotsRequest.Builder maxResults(Integer maxResults)

The maximum number of deployment job results returned by ListRobots in paginated output. When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable.

Parameters:

maxResults - The maximum number of deployment job results returned by ListRobots in paginated output. When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable.

Returns:

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

filters

ListRobotsRequest.Builder filters(Collection<Filter> filters)

Optional filters to limit results.

Parameters:

filters - Optional filters to limit results.

Returns:

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

filters

ListRobotsRequest.Builder filters(Filter... filters)

Optional filters to limit results.

Parameters:

filters - Optional filters to limit results.

Returns:

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

filters

ListRobotsRequest.Builder filters(Consumer<Filter.Builder>... filters)

Optional filters to limit results.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

overrideConfiguration

ListRobotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ListRobotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.