software.amazon.awssdk.services.pi.model

Interface GetResourceMetricsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>, PiRequest.Builder, SdkBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetResourceMetricsRequest

public static interface GetResourceMetricsRequest.Builder
extends PiRequest.Builder, SdkPojo, CopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>

Method Summary

Modifier and Type	Method and Description
GetResourceMetricsRequest.Builder	endTime(Instant endTime) The date and time specifiying the end of the requested time series data.
GetResourceMetricsRequest.Builder	identifier(String identifier) An immutable, AWS Region-unique identifier for a data source.
GetResourceMetricsRequest.Builder	maxResults(Integer maxResults) The maximum number of items to return in the response.
GetResourceMetricsRequest.Builder	metricQueries(Collection<MetricQuery> metricQueries) An array of one or more queries to perform.
GetResourceMetricsRequest.Builder	metricQueries(Consumer<MetricQuery.Builder>... metricQueries) An array of one or more queries to perform.
GetResourceMetricsRequest.Builder	metricQueries(MetricQuery... metricQueries) An array of one or more queries to perform.
GetResourceMetricsRequest.Builder	nextToken(String nextToken) An optional pagination token provided by a previous request.
GetResourceMetricsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetResourceMetricsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetResourceMetricsRequest.Builder	periodInSeconds(Integer periodInSeconds) The granularity, in seconds, of the data points returned from Performance Insights.
GetResourceMetricsRequest.Builder	serviceType(ServiceType serviceType) The AWS service for which Performance Insights will return metrics.
GetResourceMetricsRequest.Builder	serviceType(String serviceType) The AWS service for which Performance Insights will return metrics.
GetResourceMetricsRequest.Builder	startTime(Instant startTime) The date and time specifying the beginning of the requested time series data.

Methods inherited from interface software.amazon.awssdk.services.pi.model.PiRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

serviceType

GetResourceMetricsRequest.Builder serviceType(String serviceType)

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Parameters:

serviceType - The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

serviceType

GetResourceMetricsRequest.Builder serviceType(ServiceType serviceType)

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Parameters:

serviceType - The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

identifier

GetResourceMetricsRequest.Builder identifier(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

metricQueries

GetResourceMetricsRequest.Builder metricQueries(Collection<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.

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

GetResourceMetricsRequest.Builder metricQueries(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.

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

GetResourceMetricsRequest.Builder metricQueries(Consumer<MetricQuery.Builder>... 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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #metricQueries(List).

Parameters:

metricQueries - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#metricQueries(List)

startTime

GetResourceMetricsRequest.Builder startTime(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

GetResourceMetricsRequest.Builder endTime(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

periodInSeconds

GetResourceMetricsRequest.Builder periodInSeconds(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.

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

GetResourceMetricsRequest.Builder maxResults(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

GetResourceMetricsRequest.Builder nextToken(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.

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 by MaxRecords.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetResourceMetricsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.