Interface UpdateFleetMetricRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateFleetMetricRequest.Builder,
,UpdateFleetMetricRequest> IotRequest.Builder
,SdkBuilder<UpdateFleetMetricRequest.Builder,
,UpdateFleetMetricRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateFleetMetricRequest
-
Method Summary
Modifier and TypeMethodDescriptionaggregationField
(String aggregationField) The field to aggregate.default UpdateFleetMetricRequest.Builder
aggregationType
(Consumer<AggregationType.Builder> aggregationType) The type of the aggregation query.aggregationType
(AggregationType aggregationType) The type of the aggregation query.description
(String description) The description of the fleet metric.expectedVersion
(Long expectedVersion) The expected version of the fleet metric record in the registry.The name of the index to search.metricName
(String metricName) The name of the fleet metric to update.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The time in seconds between fleet metric emissions.queryString
(String queryString) The search query string.queryVersion
(String queryVersion) The version of the query.Used to support unit transformation such as milliseconds to seconds.unit
(FleetMetricUnit unit) Used to support unit transformation such as milliseconds to seconds.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
-
metricName
The name of the fleet metric to update.
- Parameters:
metricName
- The name of the fleet metric to update.- 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.
-
aggregationType
The type of the aggregation query.
- Parameters:
aggregationType
- The type of the aggregation query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aggregationType
default UpdateFleetMetricRequest.Builder aggregationType(Consumer<AggregationType.Builder> aggregationType) The type of the aggregation query.
This is a convenience method that creates an instance of theAggregationType.Builder
avoiding the need to create one manually viaAggregationType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaggregationType(AggregationType)
.- Parameters:
aggregationType
- a consumer that will call methods onAggregationType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
period
The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
- Parameters:
period
- The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aggregationField
The field to aggregate.
- Parameters:
aggregationField
- The field to aggregate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the fleet metric.
- Parameters:
description
- The description of the fleet metric.- 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.
-
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.
-
unit
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
- Parameters:
unit
- Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
unit
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
- Parameters:
unit
- Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
expectedVersion
The expected version of the fleet metric record in the registry.
- Parameters:
expectedVersion
- The expected version of the fleet metric record in the registry.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateFleetMetricRequest.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
UpdateFleetMetricRequest.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.
-