software.amazon.awssdk.services.lookoutmetrics.model

Class TimeSeries

java.lang.Object

software.amazon.awssdk.services.lookoutmetrics.model.TimeSeries

All Implemented Interfaces:

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

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

Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TimeSeries.Builder

Method Summary

Modifier and Type	Method and Description
static TimeSeries.Builder	builder()
List<DimensionNameValue>	dimensionList() The dimensions of the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensionList() For responses, this returns true if the service returned a value for the DimensionList property.
int	hashCode()
boolean	hasMetricValueList() For responses, this returns true if the service returned a value for the MetricValueList property.
List<Double>	metricValueList() The values for the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends TimeSeries.Builder>	serializableBuilderClass()
String	timeSeriesId() The ID of the metric.
TimeSeries.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

timeSeriesId

public final String timeSeriesId()

The ID of the metric.

Returns:

The ID of the metric.

hasDimensionList

public final boolean hasDimensionList()

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

dimensionList

public final List<DimensionNameValue> dimensionList()

The dimensions of 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 hasDimensionList() method.

Returns:

The dimensions of the metric.

hasMetricValueList

public final boolean hasMetricValueList()

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

metricValueList

public final List<Double> metricValueList()

The values for 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 hasMetricValueList() method.

Returns:

The values for the metric.

toBuilder

public TimeSeries.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimeSeries.Builder,TimeSeries>

builder

public static TimeSeries.Builder builder()

serializableBuilderClass

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