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

Class CreateFleetMetricRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFleetMetricRequest.Builder,CreateFleetMetricRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFleetMetricRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aggregationField()	The field to aggregate.
AggregationType	aggregationType()	The type of the aggregation query.
static CreateFleetMetricRequest.Builder	builder()
String	description()	The fleet metric description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	indexName()	The name of the index to search.
String	metricName()	The name of the fleet metric to create.
Integer	period()	The time in seconds between fleet metric emissions.
String	queryString()	The search query string.
String	queryVersion()	The query version.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFleetMetricRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Metadata, which can be used to manage the fleet metric.
CreateFleetMetricRequest.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 create.

Returns:

The name of the fleet metric to create.

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 fleet metric description.

Returns:

The fleet metric description.

queryVersion

public final String queryVersion()

The query version.

Returns:

The query version.

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. Default to null.

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. Default to null.

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. Default to null.

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. Default to null.

See Also:

FleetMetricUnit

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

toBuilder

public CreateFleetMetricRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFleetMetricRequest.Builder,CreateFleetMetricRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateFleetMetricRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFleetMetricRequest.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