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

Class UpdateFleetMetricRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.UpdateFleetMetricRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFleetMetricRequest.Builder,UpdateFleetMetricRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateFleetMetricRequest
extends IotRequest
implements ToCopyableBuilder<UpdateFleetMetricRequest.Builder,UpdateFleetMetricRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateFleetMetricRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aggregationField()	The field to aggregate.
AggregationType	aggregationType()	The type of the aggregation query.
static UpdateFleetMetricRequest.Builder	builder()
String	description()	The description of the fleet metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	expectedVersion()	The expected version of the fleet metric record in the registry.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName()	The name of the index to search.
String	metricName()	The name of the fleet metric to update.
Integer	period()	The time in seconds between fleet metric emissions.
String	queryString()	The search query string.
String	queryVersion()	The version of the query.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFleetMetricRequest.Builder>	serializableBuilderClass()
UpdateFleetMetricRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FleetMetricUnit	unit()	Used to support unit transformation such as milliseconds to seconds.
String	unitAsString()	Used to support unit transformation such as milliseconds to seconds.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

metricName

public final String metricName()

The name of the fleet metric to update.

Returns:

The name of the fleet metric to update.

queryString

public final String queryString()

The search query string.

Returns:

The search query string.

aggregationType

public final AggregationType aggregationType()

The type of the aggregation query.

Returns:

The type of the aggregation query.

period

public final Integer period()

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Returns:

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

aggregationField

public final String aggregationField()

The field to aggregate.

Returns:

The field to aggregate.

description

public final String description()

The description of the fleet metric.

Returns:

The description of the fleet metric.

queryVersion

public final String queryVersion()

The version of the query.

Returns:

The version of the query.

indexName

public final String indexName()

The name of the index to search.

Returns:

The name of the index to search.

unit

public final FleetMetricUnit unit()

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

If the service returns an enum value that is not available in the current SDK version, unit will return FleetMetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

Returns:

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

See Also:

FleetMetricUnit

unitAsString

public final String unitAsString()

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

If the service returns an enum value that is not available in the current SDK version, unit will return FleetMetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

Returns:

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

See Also:

FleetMetricUnit

expectedVersion

public final Long expectedVersion()

The expected version of the fleet metric record in the registry.

Returns:

The expected version of the fleet metric record in the registry.

toBuilder

public UpdateFleetMetricRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFleetMetricRequest.Builder,UpdateFleetMetricRequest>

Specified by:

toBuilder in class IotRequest

builder

public static UpdateFleetMetricRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFleetMetricRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo