Interface SearchDevicesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BraketRequest.Builder, Buildable, CopyableBuilder<SearchDevicesRequest.Builder,SearchDevicesRequest>, SdkBuilder<SearchDevicesRequest.Builder,SearchDevicesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchDevicesRequest

@Mutable
@NotThreadSafe
public static interface SearchDevicesRequest.Builder
extends BraketRequest.Builder, SdkPojo, CopyableBuilder<SearchDevicesRequest.Builder,SearchDevicesRequest>

Method Summary

Modifier and Type	Method	Description
SearchDevicesRequest.Builder	filters(Collection<SearchDevicesFilter> filters)	Array of SearchDevicesFilter objects to use when searching for devices.
SearchDevicesRequest.Builder	filters(Consumer<SearchDevicesFilter.Builder>... filters)	Array of SearchDevicesFilter objects to use when searching for devices.
SearchDevicesRequest.Builder	filters(SearchDevicesFilter... filters)	Array of SearchDevicesFilter objects to use when searching for devices.
SearchDevicesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in the response.
SearchDevicesRequest.Builder	nextToken(String nextToken)	A token used for pagination of results returned in the response.
SearchDevicesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchDevicesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.braket.model.BraketRequest.Builder

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

nextToken

SearchDevicesRequest.Builder nextToken(String nextToken)

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

Parameters:

nextToken - A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

Returns:

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

maxResults

SearchDevicesRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in the response.

Parameters:

maxResults - The maximum number of results to return in the response.

Returns:

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

filters

SearchDevicesRequest.Builder filters(Collection<SearchDevicesFilter> filters)

Array of SearchDevicesFilter objects to use when searching for devices.

Parameters:

filters - Array of SearchDevicesFilter objects to use when searching for devices.

Returns:

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

filters

SearchDevicesRequest.Builder filters(SearchDevicesFilter... filters)

Array of SearchDevicesFilter objects to use when searching for devices.

Parameters:

filters - Array of SearchDevicesFilter objects to use when searching for devices.

Returns:

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

filters

SearchDevicesRequest.Builder filters(Consumer<SearchDevicesFilter.Builder>... filters)

Array of SearchDevicesFilter objects to use when searching for devices.

This is a convenience method that creates an instance of the SearchDevicesFilter.Builder avoiding the need to create one manually via SearchDevicesFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<SearchDevicesFilter>).

Parameters:

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

Returns:

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

See Also:

• filters(java.util.Collection<SearchDevicesFilter>)

overrideConfiguration

SearchDevicesRequest.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

SearchDevicesRequest.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.