Class AuditFinding

java.lang.Object
software.amazon.awssdk.services.iot.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>

The findings (results) of the audit.

See Also:

  • Method Details

    • findingId

      public final String findingId()

      A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

      Returns:
      A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

    • taskId

      public final String taskId()

      The ID of the audit that generated this result (finding).

      Returns:
      The ID of the audit that generated this result (finding).

    • checkName

      public final String checkName()

      The audit check that generated this result.

      Returns:
      The audit check that generated this result.

    • taskStartTime

      public final Instant taskStartTime()

      The time the audit started.

      Returns:
      The time the audit started.

    • findingTime

      public final Instant findingTime()

      The time the result (finding) was discovered.

      Returns:
      The time the result (finding) was discovered.

    • severity

      public final AuditFindingSeverity severity()

      The severity of the result (finding).

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

      Returns:
      The severity of the result (finding).
      See Also:

    • severityAsString

      public final String severityAsString()

      The severity of the result (finding).

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

      Returns:
      The severity of the result (finding).
      See Also:

    • nonCompliantResource

      public final NonCompliantResource nonCompliantResource()

      The resource that was found to be noncompliant with the audit check.

      Returns:
      The resource that was found to be noncompliant with the audit check.

    • hasRelatedResources

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

    • relatedResources

      public final List<RelatedResource> relatedResources()

      The list of related resources.

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

      Returns:
      The list of related resources.

    • reasonForNonCompliance

      public final String reasonForNonCompliance()

      The reason the resource was noncompliant.

      Returns:
      The reason the resource was noncompliant.

    • reasonForNonComplianceCode

      public final String reasonForNonComplianceCode()

      A code that indicates the reason that the resource was noncompliant.

      Returns:
      A code that indicates the reason that the resource was noncompliant.

    • isSuppressed

      public final Boolean isSuppressed()

      Indicates whether the audit finding was suppressed or not during reporting.

      Returns:
      Indicates whether the audit finding was suppressed or not during reporting.

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