software.amazon.awssdk.services.iot.model

Interface DescribeFleetMetricResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeFleetMetricResponse.Builder,DescribeFleetMetricResponse>, IotResponse.Builder, SdkBuilder<DescribeFleetMetricResponse.Builder,DescribeFleetMetricResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeFleetMetricResponse

public static interface DescribeFleetMetricResponse.Builder
extends IotResponse.Builder, SdkPojo, CopyableBuilder<DescribeFleetMetricResponse.Builder,DescribeFleetMetricResponse>

Method Summary

Modifier and Type	Method and Description
DescribeFleetMetricResponse.Builder	aggregationField(String aggregationField) The field to aggregate.
DescribeFleetMetricResponse.Builder	aggregationType(AggregationType aggregationType) The type of the aggregation query.
default DescribeFleetMetricResponse.Builder	aggregationType(Consumer<AggregationType.Builder> aggregationType) The type of the aggregation query.
DescribeFleetMetricResponse.Builder	creationDate(Instant creationDate) The date when the fleet metric is created.
DescribeFleetMetricResponse.Builder	description(String description) The fleet metric description.
DescribeFleetMetricResponse.Builder	indexName(String indexName) The name of the index to search.
DescribeFleetMetricResponse.Builder	lastModifiedDate(Instant lastModifiedDate) The date when the fleet metric is last modified.
DescribeFleetMetricResponse.Builder	metricArn(String metricArn) The ARN of the fleet metric to describe.
DescribeFleetMetricResponse.Builder	metricName(String metricName) The name of the fleet metric to describe.
DescribeFleetMetricResponse.Builder	period(Integer period) The time in seconds between fleet metric emissions.
DescribeFleetMetricResponse.Builder	queryString(String queryString) The search query string.
DescribeFleetMetricResponse.Builder	queryVersion(String queryVersion) The query version.
DescribeFleetMetricResponse.Builder	unit(FleetMetricUnit unit) Used to support unit transformation such as milliseconds to seconds.
DescribeFleetMetricResponse.Builder	unit(String unit) Used to support unit transformation such as milliseconds to seconds.
DescribeFleetMetricResponse.Builder	version(Long version) The version of the fleet metric.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

metricName

DescribeFleetMetricResponse.Builder metricName(String metricName)

The name of the fleet metric to describe.

Parameters:

metricName - The name of the fleet metric to describe.

Returns:

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

queryString

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

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

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

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

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

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

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

creationDate

DescribeFleetMetricResponse.Builder creationDate(Instant creationDate)

The date when the fleet metric is created.

Parameters:

creationDate - The date when the fleet metric is created.

Returns:

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

lastModifiedDate

DescribeFleetMetricResponse.Builder lastModifiedDate(Instant lastModifiedDate)

The date when the fleet metric is last modified.

Parameters:

lastModifiedDate - The date when the fleet metric is last modified.

Returns:

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

unit

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

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

version

DescribeFleetMetricResponse.Builder version(Long version)

The version of the fleet metric.

Parameters:

version - The version of the fleet metric.

Returns:

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

metricArn

DescribeFleetMetricResponse.Builder metricArn(String metricArn)

The ARN of the fleet metric to describe.

Parameters:

metricArn - The ARN of the fleet metric to describe.

Returns:

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