Interface GetBucketsAggregationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetBucketsAggregationRequest.Builder,GetBucketsAggregationRequest>, IotRequest.Builder, SdkBuilder<GetBucketsAggregationRequest.Builder,GetBucketsAggregationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetBucketsAggregationRequest

@Mutable
@NotThreadSafe
public static interface GetBucketsAggregationRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<GetBucketsAggregationRequest.Builder,GetBucketsAggregationRequest>

Method Summary

Modifier and Type	Method	Description
GetBucketsAggregationRequest.Builder	aggregationField(String aggregationField)	The aggregation field.
default GetBucketsAggregationRequest.Builder	bucketsAggregationType(Consumer<BucketsAggregationType.Builder> bucketsAggregationType)	The basic control of the response shape and the bucket aggregation type to perform.
GetBucketsAggregationRequest.Builder	bucketsAggregationType(BucketsAggregationType bucketsAggregationType)	The basic control of the response shape and the bucket aggregation type to perform.
GetBucketsAggregationRequest.Builder	indexName(String indexName)	The name of the index to search.
GetBucketsAggregationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetBucketsAggregationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetBucketsAggregationRequest.Builder	queryString(String queryString)	The search query string.
GetBucketsAggregationRequest.Builder	queryVersion(String queryVersion)	The version of the query.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

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

indexName

GetBucketsAggregationRequest.Builder indexName(String indexName)

The name of the index to search.

Parameters:

indexName - The name of the index to search.

Returns:

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

queryString

GetBucketsAggregationRequest.Builder queryString(String queryString)

The search query string.

Parameters:

queryString - The search query string.

Returns:

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

aggregationField

GetBucketsAggregationRequest.Builder aggregationField(String aggregationField)

The aggregation field.

Parameters:

aggregationField - The aggregation field.

Returns:

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

queryVersion

GetBucketsAggregationRequest.Builder queryVersion(String queryVersion)

The version of the query.

Parameters:

queryVersion - The version of the query.

Returns:

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

bucketsAggregationType

GetBucketsAggregationRequest.Builder bucketsAggregationType(BucketsAggregationType bucketsAggregationType)

The basic control of the response shape and the bucket aggregation type to perform.

Parameters:

bucketsAggregationType - The basic control of the response shape and the bucket aggregation type to perform.

Returns:

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

bucketsAggregationType

default GetBucketsAggregationRequest.Builder bucketsAggregationType(Consumer<BucketsAggregationType.Builder> bucketsAggregationType)

The basic control of the response shape and the bucket aggregation type to perform.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bucketsAggregationType(BucketsAggregationType).

Parameters:

bucketsAggregationType - a consumer that will call methods on BucketsAggregationType.Builder

Returns:

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

See Also:

• bucketsAggregationType(BucketsAggregationType)

overrideConfiguration

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

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