Class MetricDataResult
- java.lang.Object
-
- software.amazon.awssdk.services.cloudwatch.model.MetricDataResult
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MetricDataResult.Builder,MetricDataResult>
@Generated("software.amazon.awssdk:codegen") public final class MetricDataResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricDataResult.Builder,MetricDataResult>
A
GetMetricData
call returns an array ofMetricDataResult
structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MetricDataResult.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MetricDataResult.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
hasTimestamps()
For responses, this returns true if the service returned a value for the Timestamps property.boolean
hasValues()
For responses, this returns true if the service returned a value for the Values property.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.List<SdkField<?>>
sdkFields()
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 timestamps for the data points, formatted in Unix timestamp format.MetricDataResult.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<Double>
values()
The data points for the metric corresponding toTimestamps
.-
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
-
id
public final String id()
The short name you specified to represent this metric.
- Returns:
- The short name you specified to represent this metric.
-
label
public final String label()
The human-readable label associated with the data.
- Returns:
- The human-readable label associated with the data.
-
hasTimestamps
public final boolean hasTimestamps()
For responses, this returns true if the service returned a value for the Timestamps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
timestamps
public final List<Instant> timestamps()
The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps 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.
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
hasTimestamps()
method.- Returns:
- The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].
-
hasValues
public final boolean hasValues()
For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
values
public final List<Double> values()
The data points for the metric corresponding to
Timestamps
. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].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
hasValues()
method.- Returns:
- The data points for the metric corresponding to
Timestamps
. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].
-
statusCode
public final 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 theNextToken
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 usingNextToken
, if present.If the service returns an enum value that is not available in the current SDK version,
statusCode
will returnStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- 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 theNextToken
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 usingNextToken
, if present. - See Also:
StatusCode
-
statusCodeAsString
public final 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 theNextToken
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 usingNextToken
, if present.If the service returns an enum value that is not available in the current SDK version,
statusCode
will returnStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- 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 theNextToken
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 usingNextToken
, if present. - See Also:
StatusCode
-
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 theisEmpty()
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()
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.
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:
- A list of messages with additional information about the data returned.
-
toBuilder
public MetricDataResult.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<MetricDataResult.Builder,MetricDataResult>
-
builder
public static MetricDataResult.Builder builder()
-
serializableBuilderClass
public static Class<? extends MetricDataResult.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-