software.amazon.awssdk.services.cloudwatch.model

Class MetricDataResult

java.lang.Object

software.amazon.awssdk.services.cloudwatch.model.MetricDataResult

All Implemented Interfaces:

ToCopyableBuilder<MetricDataResult.Builder,MetricDataResult>

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

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the time stamps of those data points and other identifying information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricDataResult.Builder

Method Summary

Modifier and Type	Method and Description
static MetricDataResult.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The short name you specified to represent this metric.
String	label() The human-readable label associated with the data.
List<MessageData>	messages() A list of messages with additional information about the data returned.
static Class<? extends MetricDataResult.Builder>	serializableBuilderClass()
StatusCode	statusCode() The status of the returned data.
String	statusCodeAsString() The status of the returned data.
List<Instant>	timestamps() The time stamps for the data points, formatted in Unix timestamp format.
MetricDataResult.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<Double>	values() The data points for the metric corresponding to Timestamps.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public String id()

The short name you specified to represent this metric.

Returns:

The short name you specified to represent this metric.

label

public String label()

The human-readable label associated with the data.

Returns:

The human-readable label associated with the data.

timestamps

public List<Instant> timestamps()

The time stamps for the data points, formatted in Unix timestamp format. The number of time stamps always matches the number of values and the value for Timestamps[x] is Values[x].

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The time stamps for the data points, formatted in Unix timestamp format. The number of time stamps always matches the number of values and the value for Timestamps[x] is Values[x].

values

public List<Double> values()

The data points for the metric corresponding to Timestamps. The number of values always matches the number of time stamps and the time stamp for Values[x] is Timestamps[x].

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The data points for the metric corresponding to Timestamps. The number of values always matches the number of time stamps and the time stamp for Values[x] is Timestamps[x].

statusCode

public StatusCode statusCode()

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

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

Returns:

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

See Also:

StatusCode

statusCodeAsString

public String statusCodeAsString()

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

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

Returns:

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

See Also:

StatusCode

messages

public List<MessageData> messages()

A list of messages with additional information about the data returned.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of messages with additional information about the data returned.

toBuilder

public MetricDataResult.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MetricDataResult.Builder,MetricDataResult>

Returns:

a builder for type T

builder

public static MetricDataResult.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)