Interface CreateFleetMetricRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateFleetMetricRequest.Builder,,CreateFleetMetricRequest> IotRequest.Builder,SdkBuilder<CreateFleetMetricRequest.Builder,,CreateFleetMetricRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateFleetMetricRequest
public static interface CreateFleetMetricRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateFleetMetricRequest.Builder,CreateFleetMetricRequest>
-
Method Summary
Modifier and TypeMethodDescriptionaggregationField(String aggregationField) The field to aggregate.default CreateFleetMetricRequest.BuilderaggregationType(Consumer<AggregationType.Builder> aggregationType) The type of the aggregation query.aggregationType(AggregationType aggregationType) The type of the aggregation query.description(String description) The fleet metric description.The name of the index to search.metricName(String metricName) The name of the fleet metric to create.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 query version.tags(Collection<Tag> tags) Metadata, which can be used to manage the fleet metric.tags(Consumer<Tag.Builder>... tags) Metadata, which can be used to manage the fleet metric.Metadata, which can be used to manage the fleet metric.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
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
metricName
The name of the fleet metric to create.
- Parameters:
metricName- The name of the fleet metric to create.- 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 CreateFleetMetricRequest.Builder aggregationType(Consumer<AggregationType.Builder> aggregationType) The type of the aggregation query.
This is a convenience method that creates an instance of theAggregationType.Builderavoiding the need to create one manually viaAggregationType.builder().When the
Consumercompletes,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 fleet metric description.
- Parameters:
description- The fleet metric description.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queryVersion
The query version.
- Parameters:
queryVersion- The query version.- 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. Default to null.
- Parameters:
unit- Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.- 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. Default to null.
- Parameters:
unit- Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Metadata, which can be used to manage the fleet metric.
- Parameters:
tags- Metadata, which can be used to manage the fleet metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata, which can be used to manage the fleet metric.
- Parameters:
tags- Metadata, which can be used to manage the fleet metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata, which can be used to manage the fleet metric.
This is a convenience method that creates an instance of theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totags(List<Tag>).- Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateFleetMetricRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateFleetMetricRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-