software.amazon.awssdk.services.iot.model

Class MetricValue

java.lang.Object

software.amazon.awssdk.services.iot.model.MetricValue

All Implemented Interfaces:

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

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

The value to be compared with the metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricValue.Builder

Method Summary

Modifier and Type	Method and Description
static MetricValue.Builder	builder()
List<String>	cidrs() If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
Long	count() If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCidrs() For responses, this returns true if the service returned a value for the Cidrs property.
int	hashCode()
boolean	hasNumbers() For responses, this returns true if the service returned a value for the Numbers property.
boolean	hasPorts() For responses, this returns true if the service returned a value for the Ports property.
boolean	hasStrings() For responses, this returns true if the service returned a value for the Strings property.
Double	number() The numeral value of a metric.
List<Double>	numbers() The numeral values of a metric.
List<Integer>	ports() If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricValue.Builder>	serializableBuilderClass()
List<String>	strings() The string values of a metric.
MetricValue.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

count

public final Long count()

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

Returns:

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

hasCidrs

public final boolean hasCidrs()

For responses, this returns true if the service returned a value for the Cidrs 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.

cidrs

public final List<String> cidrs()

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the 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 hasCidrs() method.

Returns:

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

hasPorts

public final boolean hasPorts()

For responses, this returns true if the service returned a value for the Ports 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.

ports

public final List<Integer> ports()

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the 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 hasPorts() method.

Returns:

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

number

public final Double number()

The numeral value of a metric.

Returns:

The numeral value of a metric.

hasNumbers

public final boolean hasNumbers()

For responses, this returns true if the service returned a value for the Numbers 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.

numbers

public final List<Double> numbers()

The numeral values of a 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 hasNumbers() method.

Returns:

The numeral values of a metric.

hasStrings

public final boolean hasStrings()

For responses, this returns true if the service returned a value for the Strings 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.

strings

public final List<String> strings()

The string values of a 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 hasStrings() method.

Returns:

The string values of a metric.

toBuilder

public MetricValue.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricValue.Builder,MetricValue>

builder

public static MetricValue.Builder builder()

serializableBuilderClass

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