Interface UpdateFleetMetricRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateFleetMetricRequest

public static interface UpdateFleetMetricRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<UpdateFleetMetricRequest.Builder,UpdateFleetMetricRequest>

Method Summary

Modifier and Type	Method	Description
UpdateFleetMetricRequest.Builder	aggregationField(String aggregationField)	The field to aggregate.
default UpdateFleetMetricRequest.Builder	aggregationType(Consumer<AggregationType.Builder> aggregationType)	The type of the aggregation query.
UpdateFleetMetricRequest.Builder	aggregationType(AggregationType aggregationType)	The type of the aggregation query.
UpdateFleetMetricRequest.Builder	description(String description)	The description of the fleet metric.
UpdateFleetMetricRequest.Builder	expectedVersion(Long expectedVersion)	The expected version of the fleet metric record in the registry.
UpdateFleetMetricRequest.Builder	indexName(String indexName)	The name of the index to search.
UpdateFleetMetricRequest.Builder	metricName(String metricName)	The name of the fleet metric to update.
UpdateFleetMetricRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateFleetMetricRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateFleetMetricRequest.Builder	period(Integer period)	The time in seconds between fleet metric emissions.
UpdateFleetMetricRequest.Builder	queryString(String queryString)	The search query string.
UpdateFleetMetricRequest.Builder	queryVersion(String queryVersion)	The version of the query.
UpdateFleetMetricRequest.Builder	unit(String unit)	Used to support unit transformation such as milliseconds to seconds.
UpdateFleetMetricRequest.Builder	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

UpdateFleetMetricRequest.Builder metricName(String 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

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

aggregationType

UpdateFleetMetricRequest.Builder aggregationType(AggregationType 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 the AggregationType.Builder avoiding the need to create one manually via AggregationType.builder().

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

Parameters:

aggregationType - a consumer that will call methods on AggregationType.Builder

Returns:

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

See Also:

• aggregationType(AggregationType)

period

UpdateFleetMetricRequest.Builder period(Integer 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

UpdateFleetMetricRequest.Builder aggregationField(String 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

UpdateFleetMetricRequest.Builder description(String 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

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

indexName

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

unit

UpdateFleetMetricRequest.Builder unit(String 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:

• FleetMetricUnit
• FleetMetricUnit

unit

UpdateFleetMetricRequest.Builder unit(FleetMetricUnit 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:

• FleetMetricUnit
• FleetMetricUnit

expectedVersion

UpdateFleetMetricRequest.Builder expectedVersion(Long 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 interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.