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

Class GetResourceMetricsRequest

    • Method Detail

      • serviceType

        public final ServiceType serviceType()

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

        • RDS

        • DOCDB

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

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

        • RDS

        • DOCDB

        See Also:
        ServiceType

      • serviceTypeAsString

        public final String serviceTypeAsString()

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

        • RDS

        • DOCDB

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

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

        • RDS

        • DOCDB

        See Also:
        ServiceType

      • identifier

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

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

      • hasMetricQueries

        public final boolean hasMetricQueries()
        For responses, this returns true if the service returned a value for the MetricQueries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • metricQueries

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricQueries() method.

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

      • startTime

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

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

      • endTime

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

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

      • periodInSeconds

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

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

      • maxResults

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

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

      • nextToken

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

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

      • periodAlignment

        public final PeriodAlignment periodAlignment()

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

        If the service returns an enum value that is not available in the current SDK version, periodAlignment will return PeriodAlignment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAlignmentAsString().

        Returns:
        The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.
        See Also:
        PeriodAlignment

      • periodAlignmentAsString

        public final String periodAlignmentAsString()

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

        If the service returns an enum value that is not available in the current SDK version, periodAlignment will return PeriodAlignment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAlignmentAsString().

        Returns:
        The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.
        See Also:
        PeriodAlignment

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object