AuditFinding (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.iot.model.AuditFinding

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AuditFinding.Builder,AuditFinding>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AuditFinding.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AuditFinding.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AuditFinding.Builder`	`builder()`
`String`	`checkName()` The audit check that generated this result.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`findingId()` A unique identifier for this set of audit findings.
`Instant`	`findingTime()` The time the result (finding) was discovered.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRelatedResources()` For responses, this returns true if the service returned a value for the RelatedResources property.
`Boolean`	`isSuppressed()` Indicates whether the audit finding was suppressed or not during reporting.
`NonCompliantResource`	`nonCompliantResource()` The resource that was found to be noncompliant with the audit check.
`String`	`reasonForNonCompliance()` The reason the resource was noncompliant.
`String`	`reasonForNonComplianceCode()` A code that indicates the reason that the resource was noncompliant.
`List<RelatedResource>`	`relatedResources()` The list of related resources.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AuditFinding.Builder>`	`serializableBuilderClass()`
`AuditFindingSeverity`	`severity()` The severity of the result (finding).
`String`	`severityAsString()` The severity of the result (finding).
`String`	`taskId()` The ID of the audit that generated this result (finding).
`Instant`	`taskStartTime()` The time the audit started.
`AuditFinding.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    AuditFindingSeverity
  - 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:
    
    AuditFindingSeverity
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AuditFinding.Builder,AuditFinding>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AuditFinding

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

findingId

taskId

checkName

taskStartTime

findingTime

severity

severityAsString

nonCompliantResource

hasRelatedResources

relatedResources

reasonForNonCompliance

reasonForNonComplianceCode

isSuppressed

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields