software.amazon.awssdk.services.iot.model

Class AuditFinding

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

Method Summary

Modifier and Type	Method and Description
static AuditFinding.Builder	builder()
String	checkName() The audit check that generated this result.
boolean	equals(Object obj)
Instant	findingTime() The time the result (finding) was discovered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NonCompliantResource	nonCompliantResource() The resource that was found to be non-compliant with the audit check.
String	reasonForNonCompliance() The reason the resource was non-compliant.
String	reasonForNonComplianceCode() A code which indicates the reason that the resource was non-compliant.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

taskId

public 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 String checkName()

The audit check that generated this result.

Returns:

The audit check that generated this result.

taskStartTime

public Instant taskStartTime()

The time the audit started.

Returns:

The time the audit started.

findingTime

public Instant findingTime()

The time the result (finding) was discovered.

Returns:

The time the result (finding) was discovered.

severity

public 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 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 NonCompliantResource nonCompliantResource()

The resource that was found to be non-compliant with the audit check.

Returns:

The resource that was found to be non-compliant with the audit check.

relatedResources

public List<RelatedResource> relatedResources()

The list of related resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The list of related resources.

reasonForNonCompliance

public String reasonForNonCompliance()

The reason the resource was non-compliant.

Returns:

The reason the resource was non-compliant.

reasonForNonComplianceCode

public String reasonForNonComplianceCode()

A code which indicates the reason that the resource was non-compliant.

Returns:

A code which indicates the reason that the resource was non-compliant.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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