@Generated(value="software.amazon.awssdk:codegen") public final class GetResourceMetricsRequest extends PiRequest implements ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetResourceMetricsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetResourceMetricsRequest.Builder |
builder() |
Instant |
endTime()
The date and time specifiying the end of the requested time series data.
|
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() |
String |
identifier()
An immutable, AWS Region-unique identifier for a data source.
|
Integer |
maxResults()
The maximum number of items to return in the response.
|
List<MetricQuery> |
metricQueries()
An array of one or more queries to perform.
|
String |
nextToken()
An optional pagination token provided by a previous request.
|
Integer |
periodInSeconds()
The granularity, in seconds, of the data points returned from Performance Insights.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetResourceMetricsRequest.Builder> |
serializableBuilderClass() |
ServiceType |
serviceType()
The AWS service for which Performance Insights will return metrics.
|
String |
serviceTypeAsString()
The AWS service for which Performance Insights will return metrics.
|
Instant |
startTime()
The date and time specifying the beginning of the requested time series data.
|
GetResourceMetricsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public ServiceType serviceType()
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType
is: RDS
If the service returns an enum value that is not available in the current SDK version, serviceType
will
return ServiceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
serviceTypeAsString()
.
RDS
ServiceType
public String serviceTypeAsString()
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType
is: RDS
If the service returns an enum value that is not available in the current SDK version, serviceType
will
return ServiceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
serviceTypeAsString()
.
RDS
ServiceType
public String identifier()
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value - for example:
db-FAIHNTYBKTGAUSUZQYPDS2GW4A
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value - for
example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A
public List<MetricQuery> metricQueries()
An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Instant startTime()
The date and time specifying the beginning of the requested time series data. You can't specify a
StartTime
that's earlier than 7 days ago. The value specified is inclusive - data points
equal to or greater than StartTime
will be returned.
The value for StartTime
must be earlier than the value for EndTime
.
StartTime
that's earlier than 7 days ago. The value specified is inclusive - data
points equal to or greater than StartTime
will be returned.
The value for StartTime
must be earlier than the value for EndTime
.
public Instant endTime()
The date and time specifiying the end of the requested time series data. The value specified is exclusive
- data points less than (but not equal to) EndTime
will be returned.
The value for EndTime
must be later than the value for StartTime
.
EndTime
will be returned.
The value for EndTime
must be later than the value for StartTime
.
public Integer periodInSeconds()
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights will choose a value for you, with a
goal of returning roughly 100-200 data points in the response.
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights will choose a value for you,
with a goal of returning roughly 100-200 data points in the response.
public Integer maxResults()
The maximum number of items to return in the response. If more items exist than the specified
MaxRecords
value, a pagination token is included in the response so that the remaining results can
be retrieved.
MaxRecords
value, a pagination token is included in the response so that the remaining
results can be retrieved.public String nextToken()
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the token, up to the value specified by MaxRecords
.
MaxRecords
.public GetResourceMetricsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>
toBuilder
in class PiRequest
public static GetResourceMetricsRequest.Builder builder()
public static Class<? extends GetResourceMetricsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest
fieldName
- 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.