Class GetResourceMetricsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pi.model.PiRequest
software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetResourceMetricsRequest extends PiRequest implements ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>

  • Method Details

    • 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:

    • 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:

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

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

    • 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:

    • 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:

    • toBuilder

      public GetResourceMetricsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>
      Specified by:
      toBuilder in class PiRequest
      Returns:
      a builder for type T

    • builder

      public static GetResourceMetricsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetResourceMetricsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.