Class GetMetricDataRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
-
- software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetMetricDataRequest extends CloudWatchRequest implements ToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetMetricDataRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 theTimezone
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 previousGetMetricData
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.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasMetricDataQueries
public final boolean hasMetricDataQueries()
For responses, this returns true if the service returned a value for the MetricDataQueries 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.
-
metricDataQueries
public final List<MetricDataQuery> metricDataQueries()
The metric queries to be returned. A single
GetMetricData
call can include as many as 500MetricDataQuery
structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query, 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.- Returns:
- The metric queries to be returned. A single
GetMetricData
call can include as many as 500MetricDataQuery
structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query, or a math expression to perform on retrieved data.
-
startTime
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
andEndTime
values that align with the value of the metric'sPeriod
and sync up with the beginning and end of an hour. For example, if thePeriod
of a metric is 5 minutes, specifying 12:05 or 12:30 asStartTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as theStartTime
.- Returns:
- 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
andEndTime
values that align with the value of the metric'sPeriod
and sync up with the beginning and end of an hour. For example, if thePeriod
of a metric is 5 minutes, specifying 12:05 or 12:30 asStartTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as theStartTime
. -
-
-
endTime
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
andEndTime
values that align with the value of the metric'sPeriod
and sync up with the beginning and end of an hour. For example, if thePeriod
of a metric is 5 minutes, specifying 12:05 or 12:30 asEndTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as theEndTime
.- Returns:
- 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
andEndTime
values that align with the value of the metric'sPeriod
and sync up with the beginning and end of an hour. For example, if thePeriod
of a metric is 5 minutes, specifying 12:05 or 12:30 asEndTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as theEndTime
.
-
nextToken
public final String nextToken()
Include this value, if it was returned by the previous
GetMetricData
operation, to get the next set of data points.- Returns:
- Include this value, if it was returned by the previous
GetMetricData
operation, to get the next set of data points.
-
scanBy
public final ScanBy scanBy()
The order in which data points should be returned.
TimestampDescending
returns the newest data first and paginates when theMaxDatapoints
limit is reached.TimestampAscending
returns the oldest data first and paginates when theMaxDatapoints
limit is reached.If the service returns an enum value that is not available in the current SDK version,
scanBy
will returnScanBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscanByAsString()
.- Returns:
- The order in which data points should be returned.
TimestampDescending
returns the newest data first and paginates when theMaxDatapoints
limit is reached.TimestampAscending
returns the oldest data first and paginates when theMaxDatapoints
limit is reached. - See Also:
ScanBy
-
scanByAsString
public final String scanByAsString()
The order in which data points should be returned.
TimestampDescending
returns the newest data first and paginates when theMaxDatapoints
limit is reached.TimestampAscending
returns the oldest data first and paginates when theMaxDatapoints
limit is reached.If the service returns an enum value that is not available in the current SDK version,
scanBy
will returnScanBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscanByAsString()
.- Returns:
- The order in which data points should be returned.
TimestampDescending
returns the newest data first and paginates when theMaxDatapoints
limit is reached.TimestampAscending
returns the oldest data first and paginates when theMaxDatapoints
limit is reached. - See Also:
ScanBy
-
maxDatapoints
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.
- Returns:
- The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
-
labelOptions
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.- Returns:
- 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.
-
toBuilder
public GetMetricDataRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
- Specified by:
toBuilder
in classCloudWatchRequest
-
builder
public static GetMetricDataRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetMetricDataRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-