Package software.amazon.awssdk.services.connect.model

Class MetricV2

java.lang.Object

software.amazon.awssdk.services.connect.model.MetricV2

All Implemented Interfaces:

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

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

Contains information about the metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricV2.Builder

Method Summary

Modifier and Type	Method	Description
static MetricV2.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricFilters()	For responses, this returns true if the service returned a value for the MetricFilters property.
boolean	hasThreshold()	For responses, this returns true if the service returned a value for the Threshold property.
List<MetricFilterV2>	metricFilters()	Contains the filters to be used when returning data.
String	name()	The name of the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricV2.Builder>	serializableBuilderClass()
List<ThresholdV2>	threshold()	Contains information about the threshold for service level metrics.
MetricV2.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

name

public final String name()

The name of the metric.

This parameter is required. The following Required = No is incorrect.

Returns:

The name of the metric.

This parameter is required. The following Required = No is incorrect.

hasThreshold

public final boolean hasThreshold()

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

threshold

public final List<ThresholdV2> threshold()

Contains information about the threshold for service level metrics.

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 hasThreshold() method.

Returns:

Contains information about the threshold for service level metrics.

hasMetricFilters

public final boolean hasMetricFilters()

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

metricFilters

public final List<MetricFilterV2> metricFilters()

Contains the filters to be used when returning data.

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 hasMetricFilters() method.

Returns:

Contains the filters to be used when returning data.

toBuilder

public MetricV2.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricV2.Builder,MetricV2>

builder

public static MetricV2.Builder builder()

serializableBuilderClass

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