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

Class MetricResultV2

java.lang.Object

software.amazon.awssdk.services.connect.model.MetricResultV2

All Implemented Interfaces:

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

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

Contains information about the metric results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricResultV2.Builder

Method Summary

Modifier and Type	Method	Description
static MetricResultV2.Builder	builder()
List<MetricDataV2>	collections()	The set of metrics.
Map<String,String>	dimensions()	The dimension for the metrics.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCollections()	For responses, this returns true if the service returned a value for the Collections property.
boolean	hasDimensions()	For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
MetricInterval	metricInterval()	The interval period with the start and end time for the metrics.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricResultV2.Builder>	serializableBuilderClass()
MetricResultV2.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

hasDimensions

public final boolean hasDimensions()

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

dimensions

public final Map<String,String> dimensions()

The dimension for the 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 hasDimensions() method.

Returns:

The dimension for the metrics.

metricInterval

public final MetricInterval metricInterval()

The interval period with the start and end time for the metrics.

Returns:

The interval period with the start and end time for the metrics.

hasCollections

public final boolean hasCollections()

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

collections

public final List<MetricDataV2> collections()

The set of 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 hasCollections() method.

Returns:

The set of metrics.

toBuilder

public MetricResultV2.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricResultV2.Builder,MetricResultV2>

builder

public static MetricResultV2.Builder builder()

serializableBuilderClass

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