Package software.amazon.awssdk.services.cloudwatch.model

Class GetMetricDataResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse

software.amazon.awssdk.services.cloudwatch.model.GetMetricDataResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMetricDataResponse.Builder,GetMetricDataResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetMetricDataResponse
extends CloudWatchResponse
implements ToCopyableBuilder<GetMetricDataResponse.Builder,GetMetricDataResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetMetricDataResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetMetricDataResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMessages()	For responses, this returns true if the service returned a value for the Messages property.
boolean	hasMetricDataResults()	For responses, this returns true if the service returned a value for the MetricDataResults property.
List<MessageData>	messages()	Contains a message about this GetMetricData operation, if the operation results in such a message.
List<MetricDataResult>	metricDataResults()	The metrics that are returned, including the metric name, namespace, and dimensions.
String	nextToken()	A token that marks the next batch of returned results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMetricDataResponse.Builder>	serializableBuilderClass()
GetMetricDataResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasMetricDataResults

public final boolean hasMetricDataResults()

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

metricDataResults

public final List<MetricDataResult> metricDataResults()

The metrics that are returned, including the metric name, namespace, and dimensions.

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

Returns:

The metrics that are returned, including the metric name, namespace, and dimensions.

nextToken

public final String nextToken()

A token that marks the next batch of returned results.

Returns:

A token that marks the next batch of returned results.

hasMessages

public final boolean hasMessages()

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

messages

public final List<MessageData> messages()

Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that might be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed.

A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that 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 hasMessages() method.

Returns:

Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that might be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed.

A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

toBuilder

public GetMetricDataResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMetricDataResponse.Builder,GetMetricDataResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetMetricDataResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo