Package software.amazon.awssdk.services.devopsguru.model

Class PerformanceInsightsMetricsDetail

java.lang.Object
software.amazon.awssdk.services.devopsguru.model.PerformanceInsightsMetricsDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PerformanceInsightsMetricsDetail.Builder,PerformanceInsightsMetricsDetail>
@Generated("software.amazon.awssdk:codegen") public final class PerformanceInsightsMetricsDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PerformanceInsightsMetricsDetail.Builder,PerformanceInsightsMetricsDetail>

Details about Performance Insights metrics.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

See Also:

  • Method Details

    • metricDisplayName

      public final String metricDisplayName()

      The name used for a specific Performance Insights metric.

      Returns:
      The name used for a specific Performance Insights metric.

    • unit

      public final String unit()

      The unit of measure for a metric. For example, a session or a process.

      Returns:
      The unit of measure for a metric. For example, a session or a process.

    • metricQuery

      public final PerformanceInsightsMetricQuery metricQuery()

      A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

      Returns:
      A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

    • hasReferenceData

      public final boolean hasReferenceData()
      For responses, this returns true if the service returned a value for the ReferenceData 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.

    • referenceData

      public final List<PerformanceInsightsReferenceData> referenceData()

      For more information, see PerformanceInsightsReferenceData .

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

      Returns:
      For more information, see PerformanceInsightsReferenceData .

    • hasStatsAtAnomaly

      public final boolean hasStatsAtAnomaly()
      For responses, this returns true if the service returned a value for the StatsAtAnomaly 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.

    • statsAtAnomaly

      public final List<PerformanceInsightsStat> statsAtAnomaly()

      The metric statistics during the anomalous period detected by DevOps Guru;

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

      Returns:
      The metric statistics during the anomalous period detected by DevOps Guru;

    • hasStatsAtBaseline

      public final boolean hasStatsAtBaseline()
      For responses, this returns true if the service returned a value for the StatsAtBaseline 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.

    • statsAtBaseline

      public final List<PerformanceInsightsStat> statsAtBaseline()

      Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

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

      Returns:
      Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

    • toBuilder

      public PerformanceInsightsMetricsDetail.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<PerformanceInsightsMetricsDetail.Builder,PerformanceInsightsMetricsDetail>
      Returns:
      a builder for type T

    • builder

      public static PerformanceInsightsMetricsDetail.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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