Package software.amazon.awssdk.services.pi.model

Interface GetResourceMetricsRequest.Builder

    • Method Detail

      • serviceType

        GetResourceMetricsRequest.Builder serviceType​(String 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, ServiceType

      • serviceType

        GetResourceMetricsRequest.Builder serviceType​(ServiceType 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, ServiceType

      • identifier

        GetResourceMetricsRequest.Builder identifier​(String 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 as DbiResourceId.

        To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-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 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.

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

        Parameters:
        metricQueries - 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.
        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 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.

        Parameters:
        metricQueries - 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.
        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 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.

        This is a convenience method that creates an instance of the MetricQuery.Builder avoiding the need to create one manually via MetricQuery.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #metricQueries(List).

        Parameters:
        metricQueries - a consumer that will call methods on MetricQuery.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #metricQueries(java.util.Collection)

      • startTime

        GetResourceMetricsRequest.Builder startTime​(Instant 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 than StartTime.

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

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

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

      • periodAlignment

        GetResourceMetricsRequest.Builder periodAlignment​(String 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 is END_TIME.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PeriodAlignment, PeriodAlignment

      • periodAlignment

        GetResourceMetricsRequest.Builder periodAlignment​(PeriodAlignment 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 is END_TIME.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PeriodAlignment, PeriodAlignment