Class AuditFinding

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

A structure that contains information about an audit finding, which represents an automated analysis result about service behavior, performance issues, or potential problems identified through heuristic algorithms.

See Also:

  • Method Details

    • hasKeyAttributes

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

    • keyAttributes

      public final Map<String,String> keyAttributes()

      The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.

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

      Returns:
      The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.

    • hasAuditorResults

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

    • auditorResults

      public final List<AuditorResult> auditorResults()

      An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.

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

      Returns:
      An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.

    • operation

      public final String operation()

      The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.

      Returns:
      The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.

    • metricGraph

      public final MetricGraph metricGraph()

      A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.

      Returns:
      A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.

    • dependencyGraph

      public final DependencyGraph dependencyGraph()

      A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.

      Returns:
      A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.

    • type

      public final String type()

      The type of audit finding.

      Returns:
      The type of audit finding.

    • toBuilder

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

    • builder

      public static AuditFinding.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.