Class AuditorResult

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

A structure that contains the result of an automated audit analysis, including the auditor name, description of findings, additional data, and severity level.

See Also:

  • Method Details

    • auditor

      public final String auditor()

      The name of the auditor algorithm that generated this result.

      Returns:
      The name of the auditor algorithm that generated this result.

    • description

      public final String description()

      A detailed description of the audit finding, explaining what was observed and potential implications.

      Returns:
      A detailed description of the audit finding, explaining what was observed and potential implications.

    • hasData

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

    • data

      public final Map<String,String> data()

      This is a string-to-string map. It contains additional data about the result of an automated audit analysis.

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

      Returns:
      This is a string-to-string map. It contains additional data about the result of an automated audit analysis.

    • severity

      public final Severity severity()

      The severity level of this audit finding, indicating the importance and potential impact of the issue.

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

      Returns:
      The severity level of this audit finding, indicating the importance and potential impact of the issue.
      See Also:

    • severityAsString

      public final String severityAsString()

      The severity level of this audit finding, indicating the importance and potential impact of the issue.

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

      Returns:
      The severity level of this audit finding, indicating the importance and potential impact of the issue.
      See Also:

    • toBuilder

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

    • builder

      public static AuditorResult.Builder builder()

    • serializableBuilderClass

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