Package software.amazon.awssdk.services.iot.model

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 Type	Method	Description
CreateFleetMetricRequest.Builder	aggregationField(String aggregationField)	The field to aggregate.
default CreateFleetMetricRequest.Builder	aggregationType(Consumer<AggregationType.Builder> aggregationType)	The type of the aggregation query.
CreateFleetMetricRequest.Builder	aggregationType(AggregationType aggregationType)	The type of the aggregation query.
CreateFleetMetricRequest.Builder	description(String description)	The fleet metric description.
CreateFleetMetricRequest.Builder	indexName(String indexName)	The name of the index to search.
CreateFleetMetricRequest.Builder	metricName(String metricName)	The name of the fleet metric to create.
CreateFleetMetricRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateFleetMetricRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateFleetMetricRequest.Builder	period(Integer period)	The time in seconds between fleet metric emissions.
CreateFleetMetricRequest.Builder	queryString(String queryString)	The search query string.
CreateFleetMetricRequest.Builder	queryVersion(String queryVersion)	The query version.
CreateFleetMetricRequest.Builder	tags(Collection<Tag> tags)	Metadata, which can be used to manage the fleet metric.
CreateFleetMetricRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Metadata, which can be used to manage the fleet metric.
CreateFleetMetricRequest.Builder	tags(Tag... tags)	Metadata, which can be used to manage the fleet metric.
CreateFleetMetricRequest.Builder	unit(String unit)	Used to support unit transformation such as milliseconds to seconds.
CreateFleetMetricRequest.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

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

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

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

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

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

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

CreateFleetMetricRequest.Builder queryVersion(String 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

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

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

• FleetMetricUnit
• FleetMetricUnit

unit

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

• FleetMetricUnit
• FleetMetricUnit

tags

CreateFleetMetricRequest.Builder tags(Collection<Tag> 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

CreateFleetMetricRequest.Builder tags(Tag... 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

CreateFleetMetricRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata, which can be used to manage the fleet metric.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

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

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