Interface GetBucketsAggregationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetBucketsAggregationRequest.Builder,
,GetBucketsAggregationRequest> IotRequest.Builder
,SdkBuilder<GetBucketsAggregationRequest.Builder,
,GetBucketsAggregationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetBucketsAggregationRequest
public static interface GetBucketsAggregationRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<GetBucketsAggregationRequest.Builder,GetBucketsAggregationRequest>
-
Method Summary
Modifier and TypeMethodDescriptionaggregationField
(String aggregationField) The aggregation field.bucketsAggregationType
(Consumer<BucketsAggregationType.Builder> bucketsAggregationType) The basic control of the response shape and the bucket aggregation type to perform.bucketsAggregationType
(BucketsAggregationType bucketsAggregationType) The basic control of the response shape and the bucket aggregation type to perform.The name of the index to search.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.queryString
(String queryString) The search query string.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, sdkFields
-
Method Details
-
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
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
The aggregation field.
- Parameters:
aggregationField
- The aggregation field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theBucketsAggregationType.Builder
avoiding the need to create one manually viaBucketsAggregationType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobucketsAggregationType(BucketsAggregationType)
.- Parameters:
bucketsAggregationType
- a consumer that will call methods onBucketsAggregationType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetBucketsAggregationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-