@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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
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 call, 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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic List<MetricDataQuery> metricDataQueries()
The metric queries to be returned. A single GetMetricData call can include as many as 100
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.
GetMetricData call can include as many as 100
MetricDataQuery structures. Each of these structures can specify either a metric to
retrieve, or a math expression to perform on retrieved data.public Instant startTime()
The time stamp indicating the earliest data to be returned.
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 then setting 12:07 or 12:29 as the StartTime.
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 then setting 12:07 or 12:29 as the
StartTime.
public Instant endTime()
The time stamp indicating the latest data to be returned.
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 then setting 12:07 or 12:29 as the EndTime.
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 then setting 12:07 or 12:29 as the
EndTime.
public String nextToken()
Include this value, if it was returned by the previous call, to get the next set of data points.
public 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.ScanBypublic 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.ScanBypublic 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 GetMetricDataRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>toBuilder in class CloudWatchRequestpublic static GetMetricDataRequest.Builder builder()
public static Class<? extends GetMetricDataRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.