Class AuditCheckDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuditCheckDetails.Builder,
AuditCheckDetails>
Information about the audit check.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AuditCheckDetails.Builder
builder()
final Boolean
True if the check is complete and found all resources compliant.final AuditCheckRunStatus
The completion status of this check.final String
The completion status of this check.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The code of any error encountered when this check is performed during this audit.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
message()
The message associated with any error encountered when this check is performed during this audit.final Long
The number of resources that were found noncompliant during the check.static Class
<? extends AuditCheckDetails.Builder> final Long
Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Long
The number of resources on which the check was performed.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAuditCheckRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcheckRunStatusAsString()
.- 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
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 returnAuditCheckRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcheckRunStatusAsString()
.- 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
True if the check is complete and found all resources compliant.
- Returns:
- True if the check is complete and found all resources compliant.
-
totalResourcesCount
The number of resources on which the check was performed.
- Returns:
- The number of resources on which the check was performed.
-
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
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
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
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
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 interfaceToCopyableBuilder<AuditCheckDetails.Builder,
AuditCheckDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-