Class Metric

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

Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.

See Also:

  • Method Details

    • frameName

      public final String frameName()

      The name of the method that appears as a frame in any stack in a profile.

      Returns:
      The name of the method that appears as a frame in any stack in a profile.

    • hasThreadStates

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

    • threadStates

      public final List<String> threadStates()

      The list of application runtime thread states that is used to calculate the metric value for the frame.

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

      Returns:
      The list of application runtime thread states that is used to calculate the metric value for the frame.

    • type

      public final MetricType type()

      A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

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

      Returns:
      A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.
      See Also:

    • typeAsString

      public final String typeAsString()

      A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

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

      Returns:
      A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.
      See Also:

    • toBuilder

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

    • builder

      public static Metric.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Metric.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.