Interface GetResourceMetricsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetResourceMetricsRequest.Builder,
,GetResourceMetricsRequest> PiRequest.Builder
,SdkBuilder<GetResourceMetricsRequest.Builder,
,GetResourceMetricsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetResourceMetricsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe date and time specifying the end of the requested time series query range.identifier
(String identifier) An immutable identifier for a data source that is unique for an Amazon Web Services Region.maxResults
(Integer maxResults) The maximum number of items to return in the response.metricQueries
(Collection<MetricQuery> metricQueries) An array of one or more queries to perform.metricQueries
(Consumer<MetricQuery.Builder>... metricQueries) An array of one or more queries to perform.metricQueries
(MetricQuery... metricQueries) An array of one or more queries to perform.An optional pagination token provided by a previous request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.periodAlignment
(String periodAlignment) The returned timestamp which is the start or end time of the time periods.periodAlignment
(PeriodAlignment periodAlignment) The returned timestamp which is the start or end time of the time periods.periodInSeconds
(Integer periodInSeconds) The granularity, in seconds, of the data points returned from Performance Insights.serviceType
(String serviceType) The Amazon Web Services service for which Performance Insights returns metrics.serviceType
(ServiceType serviceType) The Amazon Web Services service for which Performance Insights returns metrics.The date and time specifying the beginning of the requested time series query range.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.pi.model.PiRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
serviceType
The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
-
RDS
-
DOCDB
- Parameters:
serviceType
- The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:-
RDS
-
DOCDB
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
serviceType
The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
-
RDS
-
DOCDB
- Parameters:
serviceType
- The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:-
RDS
-
DOCDB
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
identifier
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call
DescribeDBInstances
, the identifier is returned asDbiResourceId
.To use a DB instance as a data source, specify its
DbiResourceId
value. For example, specifydb-ABCDEFGHIJKLMNOPQRSTU1VW2X
.- Parameters:
identifier
- An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you callDescribeDBInstances
, the identifier is returned asDbiResourceId
.To use a DB instance as a data source, specify its
DbiResourceId
value. For example, specifydb-ABCDEFGHIJKLMNOPQRSTU1VW2X
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theMetricQuery.Builder
avoiding the need to create one manually viaMetricQuery.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometricQueries(List<MetricQuery>)
.- Parameters:
metricQueries
- a consumer that will call methods onMetricQuery.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startTime
The date and time specifying the beginning of the requested time series query range. You can't specify a
StartTime
that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater thanStartTime
.The value for
StartTime
must be earlier than the value forEndTime
.- Parameters:
startTime
- The date and time specifying the beginning of the requested time series query range. You can't specify aStartTime
that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater thanStartTime
.The value for
StartTime
must be earlier than the value forEndTime
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to)
EndTime
.The value for
EndTime
must be later than the value forStartTime
.- Parameters:
endTime
- The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to)EndTime
.The value for
EndTime
must be later than the value forStartTime
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.- Parameters:
maxResults
- The maximum number of items to return in the response. If more items exist than the specifiedMaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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 byMaxRecords
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
periodAlignment
The returned timestamp which is the start or end time of the time periods. The default value is
END_TIME
.- Parameters:
periodAlignment
- The returned timestamp which is the start or end time of the time periods. The default value isEND_TIME
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
periodAlignment
The returned timestamp which is the start or end time of the time periods. The default value is
END_TIME
.- Parameters:
periodAlignment
- The returned timestamp which is the start or end time of the time periods. The default value isEND_TIME
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetResourceMetricsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetResourceMetricsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-