Package software.amazon.awssdk.services.codeguruprofiler.model

Class Pattern

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

A set of rules used to make a recommendation during an analysis.

See Also:

  • Method Details

    • hasCountersToAggregate

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

    • countersToAggregate

      public final List<String> countersToAggregate()

      A list of the different counters used to determine if there is a match.

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

      Returns:
      A list of the different counters used to determine if there is a match.

    • description

      public final String description()

      The description of the recommendation. This explains a potential inefficiency in a profiled application.

      Returns:
      The description of the recommendation. This explains a potential inefficiency in a profiled application.

    • id

      public final String id()

      The universally unique identifier (UUID) of this pattern.

      Returns:
      The universally unique identifier (UUID) of this pattern.

    • name

      public final String name()

      The name for this pattern.

      Returns:
      The name for this pattern.

    • resolutionSteps

      public final String resolutionSteps()

      A string that contains the steps recommended to address the potential inefficiency.

      Returns:
      A string that contains the steps recommended to address the potential inefficiency.

    • hasTargetFrames

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

    • targetFrames

      public final List<List<String>> targetFrames()

      A list of frame names that were searched during the analysis that generated a recommendation.

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

      Returns:
      A list of frame names that were searched during the analysis that generated a recommendation.

    • thresholdPercent

      public final Double thresholdPercent()

      The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

      Returns:
      The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

    • toBuilder

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

    • builder

      public static Pattern.Builder builder()

    • serializableBuilderClass

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