Class AuditFinding
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuditFinding.Builder,
AuditFinding>
The findings (results) of the audit.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AuditFinding.Builder
builder()
final String
The audit check that generated this result.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A unique identifier for this set of audit findings.final Instant
The time the result (finding) was discovered.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RelatedResources property.final Boolean
Indicates whether the audit finding was suppressed or not during reporting.final NonCompliantResource
The resource that was found to be noncompliant with the audit check.final String
The reason the resource was noncompliant.final String
A code that indicates the reason that the resource was noncompliant.final List
<RelatedResource> The list of related resources.static Class
<? extends AuditFinding.Builder> final AuditFindingSeverity
severity()
The severity of the result (finding).final String
The severity of the result (finding).final String
taskId()
The ID of the audit that generated this result (finding).final Instant
The time the audit started.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The ID of the audit that generated this result (finding).
- Returns:
- The ID of the audit that generated this result (finding).
-
checkName
The audit check that generated this result.
- Returns:
- The audit check that generated this result.
-
taskStartTime
The time the audit started.
- Returns:
- The time the audit started.
-
findingTime
The time the result (finding) was discovered.
- Returns:
- The time the result (finding) was discovered.
-
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 returnAuditFindingSeverity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromseverityAsString()
.- Returns:
- The severity of the result (finding).
- See Also:
-
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 returnAuditFindingSeverity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromseverityAsString()
.- Returns:
- The severity of the result (finding).
- See Also:
-
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 theisEmpty()
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. -
reasonForNonCompliance
The reason the resource was noncompliant.
- Returns:
- The reason the resource was noncompliant.
-
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
Indicates whether the audit finding was suppressed or not during reporting.
- Returns:
- Indicates whether the audit finding was suppressed or not during reporting.
-
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<AuditFinding.Builder,
AuditFinding> - 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
-