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

Class MetricDimension

java.lang.Object

software.amazon.awssdk.services.iot.model.MetricDimension

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MetricDimension.Builder,MetricDimension>

@Generated("software.amazon.awssdk:codegen")
public final class MetricDimension
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MetricDimension.Builder,MetricDimension>

The dimension of a metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricDimension.Builder

Method Summary

Modifier and Type	Method	Description
static MetricDimension.Builder	builder()
String	dimensionName()	A unique identifier for the dimension.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DimensionValueOperator	operator()	Defines how the dimensionValues of a dimension are interpreted.
String	operatorAsString()	Defines how the dimensionValues of a dimension are interpreted.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MetricDimension.Builder>	serializableBuilderClass()
MetricDimension.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

dimensionName

public final String dimensionName()

A unique identifier for the dimension.

Returns:

A unique identifier for the dimension.

operator

public final DimensionValueOperator operator()

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

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

Returns:

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

See Also:

DimensionValueOperator

operatorAsString

public final String operatorAsString()

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

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

Returns:

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

See Also:

DimensionValueOperator

toBuilder

public MetricDimension.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricDimension.Builder,MetricDimension>

builder

public static MetricDimension.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo