Struct aws_sdk_pi::operation::get_resource_metrics::builders::GetResourceMetricsInputBuilder

#[non_exhaustive]
pub struct GetResourceMetricsInputBuilder { /* private fields */ }

A builder for GetResourceMetricsInput.

Implementations

impl GetResourceMetricsInputBuilder

pub fn service_type(self, input: ServiceType) -> Self

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

This field is required.

pub fn set_service_type(self, input: Option<ServiceType>) -> Self

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

pub fn get_service_type(&self) -> &Option<ServiceType>

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

pub fn identifier(self, input: impl Into<String>) -> Self

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 as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

This field is required.

pub fn set_identifier(self, input: Option<String>) -> Self

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 as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

pub fn get_identifier(&self) -> &Option<String>

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 as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

pub fn metric_queries(self, input: MetricQuery) -> Self

Appends an item to metric_queries.

To override the contents of this collection use set_metric_queries.

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

pub fn set_metric_queries(self, input: Option<Vec<MetricQuery>>) -> Self

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

pub fn get_metric_queries(&self) -> &Option<Vec<MetricQuery>>

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

pub fn start_time(self, input: DateTime) -> Self

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 than StartTime.

The value for StartTime must be earlier than the value for EndTime.

This field is required.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

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 than StartTime.

The value for StartTime must be earlier than the value for EndTime.

pub fn get_start_time(&self) -> &Option<DateTime>

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 than StartTime.

The value for StartTime must be earlier than the value for EndTime.

pub fn end_time(self, input: DateTime) -> Self

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 for StartTime.

This field is required.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

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 for StartTime.

pub fn get_end_time(&self) -> &Option<DateTime>

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 for StartTime.

pub fn period_in_seconds(self, input: i32) -> Self

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.

pub fn set_period_in_seconds(self, input: Option<i32>) -> Self

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.

pub fn get_period_in_seconds(&self) -> &Option<i32>

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.

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn get_max_results(&self) -> &Option<i32>

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.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn get_next_token(&self) -> &Option<String>

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.

pub fn period_alignment(self, input: PeriodAlignment) -> Self

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

pub fn set_period_alignment(self, input: Option<PeriodAlignment>) -> Self

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

pub fn get_period_alignment(&self) -> &Option<PeriodAlignment>

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

pub fn build(self) -> Result<GetResourceMetricsInput, BuildError>

Consumes the builder and constructs a GetResourceMetricsInput.

impl GetResourceMetricsInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<GetResourceMetricsOutput, SdkError<GetResourceMetricsError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetResourceMetricsInputBuilder

fn clone(&self) -> GetResourceMetricsInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetResourceMetricsInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetResourceMetricsInputBuilder

fn default() -> GetResourceMetricsInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetResourceMetricsInputBuilder

fn eq(&self, other: &GetResourceMetricsInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetResourceMetricsInputBuilder