@Generated(value="software.amazon.awssdk:codegen") public final class GetMetricDataRequest extends CloudWatchRequest implements ToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetMetricDataRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetMetricDataRequest.Builder |
builder() |
Instant |
endTime()
The time stamp indicating the latest data to be returned.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMetricDataQueries()
For responses, this returns true if the service returned a value for the MetricDataQueries property.
|
LabelOptions |
labelOptions()
This structure includes the
Timezone parameter, which you can use to specify your time zone so that
the labels of returned data display the correct time for your time zone. |
Integer |
maxDatapoints()
The maximum number of data points the request should return before paginating.
|
List<MetricDataQuery> |
metricDataQueries()
The metric queries to be returned.
|
String |
nextToken()
Include this value, if it was returned by the previous
GetMetricData operation, to get the next set
of data points. |
ScanBy |
scanBy()
The order in which data points should be returned.
|
String |
scanByAsString()
The order in which data points should be returned.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetMetricDataRequest.Builder> |
serializableBuilderClass() |
Instant |
startTime()
The time stamp indicating the earliest data to be returned.
|
GetMetricDataRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasMetricDataQueries()
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<MetricDataQuery> metricDataQueries()
The metric queries to be returned. A single GetMetricData
call can include as many as 500
MetricDataQuery
structures. Each of these structures can specify either a metric to retrieve, or a
math expression to perform on retrieved data.
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 hasMetricDataQueries()
method.
GetMetricData
call can include as many as 500
MetricDataQuery
structures. Each of these structures can specify either a metric to
retrieve, or a math expression to perform on retrieved data.public final Instant startTime()
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the nearest
time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at
(HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you
receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using
a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime
and EndTime
values that align with the value
of the metric's Period
and sync up with the beginning and end of an hour. For example, if the
Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime
can get a
faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime
.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the
nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you
make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is
rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the
previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15
and 15:07:15.
For better performance, specify StartTime
and EndTime
values that align with
the value of the metric's Period
and sync up with the beginning and end of an hour. For
example, if the Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as
StartTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as the
StartTime
.
public final Instant endTime()
The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime
and EndTime
values that align with the value
of the metric's Period
and sync up with the beginning and end of an hour. For example, if the
Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime
can get a faster
response from CloudWatch than setting 12:07 or 12:29 as the EndTime
.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime
and EndTime
values that align with
the value of the metric's Period
and sync up with the beginning and end of an hour. For
example, if the Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as
EndTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as the
EndTime
.
public final String nextToken()
Include this value, if it was returned by the previous GetMetricData
operation, to get the next set
of data points.
GetMetricData
operation, to get the
next set of data points.public final ScanBy scanBy()
The order in which data points should be returned. TimestampDescending
returns the newest data first
and paginates when the MaxDatapoints
limit is reached. TimestampAscending
returns the
oldest data first and paginates when the MaxDatapoints
limit is reached.
If the service returns an enum value that is not available in the current SDK version, scanBy
will
return ScanBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
scanByAsString()
.
TimestampDescending
returns the newest
data first and paginates when the MaxDatapoints
limit is reached.
TimestampAscending
returns the oldest data first and paginates when the
MaxDatapoints
limit is reached.ScanBy
public final String scanByAsString()
The order in which data points should be returned. TimestampDescending
returns the newest data first
and paginates when the MaxDatapoints
limit is reached. TimestampAscending
returns the
oldest data first and paginates when the MaxDatapoints
limit is reached.
If the service returns an enum value that is not available in the current SDK version, scanBy
will
return ScanBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
scanByAsString()
.
TimestampDescending
returns the newest
data first and paginates when the MaxDatapoints
limit is reached.
TimestampAscending
returns the oldest data first and paginates when the
MaxDatapoints
limit is reached.ScanBy
public final Integer maxDatapoints()
The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
public final LabelOptions labelOptions()
This structure includes the Timezone
parameter, which you can use to specify your time zone so that
the labels of returned data display the correct time for your time zone.
Timezone
parameter, which you can use to specify your time zone
so that the labels of returned data display the correct time for your time zone.public GetMetricDataRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
toBuilder
in class CloudWatchRequest
public static GetMetricDataRequest.Builder builder()
public static Class<? extends GetMetricDataRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.