Class AuditCheckDetails

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

Information about the audit check.

See Also:

  • Method Details

    • checkRunStatus

      public final AuditCheckRunStatus checkRunStatus()

      The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

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

      Returns:
      The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
      See Also:

    • checkRunStatusAsString

      public final String checkRunStatusAsString()

      The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

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

      Returns:
      The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
      See Also:

    • checkCompliant

      public final Boolean checkCompliant()

      True if the check is complete and found all resources compliant.

      Returns:
      True if the check is complete and found all resources compliant.

    • totalResourcesCount

      public final Long totalResourcesCount()

      The number of resources on which the check was performed.

      Returns:
      The number of resources on which the check was performed.

    • nonCompliantResourcesCount

      public final Long nonCompliantResourcesCount()

      The number of resources that were found noncompliant during the check.

      Returns:
      The number of resources that were found noncompliant during the check.

    • suppressedNonCompliantResourcesCount

      public final Long suppressedNonCompliantResourcesCount()

      Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.

      Returns:
      Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.

    • errorCode

      public final String errorCode()

      The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

      Returns:
      The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

    • message

      public final String message()

      The message associated with any error encountered when this check is performed during this audit.

      Returns:
      The message associated with any error encountered when this check is performed during this audit.

    • toBuilder

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

    • builder

      public static AuditCheckDetails.Builder builder()

    • serializableBuilderClass

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