@Generated(value="software.amazon.awssdk:codegen") public final class MetricDataResult extends Object implements SdkPojo, Serializable, 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 timestamps of those data points and other
identifying information.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricDataResult.Builder |
Modifier and Type | Method and 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 to
Timestamps . |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String id()
The short name you specified to represent this metric.
public final String label()
The human-readable label associated with the data.
public final boolean hasTimestamps()
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.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.
public final boolean hasValues()
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.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.
Timestamps
. The number of values always
matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].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
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()
.
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.StatusCode
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
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()
.
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.StatusCode
public final boolean hasMessages()
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.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.
public MetricDataResult.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricDataResult.Builder,MetricDataResult>
public static MetricDataResult.Builder builder()
public static Class<? extends MetricDataResult.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2021. All rights reserved.