Package software.amazon.awssdk.services.iot.model

Interface AuditFinding.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AuditFinding.Builder,AuditFinding>, SdkBuilder<AuditFinding.Builder,AuditFinding>, SdkPojo

Enclosing class:

AuditFinding

public static interface AuditFinding.Builder
extends SdkPojo, CopyableBuilder<AuditFinding.Builder,AuditFinding>

Method Summary

Modifier and Type	Method	Description
AuditFinding.Builder	checkName(String checkName)	The audit check that generated this result.
AuditFinding.Builder	findingId(String findingId)	A unique identifier for this set of audit findings.
AuditFinding.Builder	findingTime(Instant findingTime)	The time the result (finding) was discovered.
AuditFinding.Builder	isSuppressed(Boolean isSuppressed)	Indicates whether the audit finding was suppressed or not during reporting.
default AuditFinding.Builder	nonCompliantResource(Consumer<NonCompliantResource.Builder> nonCompliantResource)	The resource that was found to be noncompliant with the audit check.
AuditFinding.Builder	nonCompliantResource(NonCompliantResource nonCompliantResource)	The resource that was found to be noncompliant with the audit check.
AuditFinding.Builder	reasonForNonCompliance(String reasonForNonCompliance)	The reason the resource was noncompliant.
AuditFinding.Builder	reasonForNonComplianceCode(String reasonForNonComplianceCode)	A code that indicates the reason that the resource was noncompliant.
AuditFinding.Builder	relatedResources(Collection<RelatedResource> relatedResources)	The list of related resources.
AuditFinding.Builder	relatedResources(Consumer<RelatedResource.Builder>... relatedResources)	The list of related resources.
AuditFinding.Builder	relatedResources(RelatedResource... relatedResources)	The list of related resources.
AuditFinding.Builder	severity(String severity)	The severity of the result (finding).
AuditFinding.Builder	severity(AuditFindingSeverity severity)	The severity of the result (finding).
AuditFinding.Builder	taskId(String taskId)	The ID of the audit that generated this result (finding).
AuditFinding.Builder	taskStartTime(Instant taskStartTime)	The time the audit started.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

findingId

AuditFinding.Builder findingId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

taskId

AuditFinding.Builder taskId(String taskId)

The ID of the audit that generated this result (finding).

Parameters:

taskId - The ID of the audit that generated this result (finding).

Returns:

Returns a reference to this object so that method calls can be chained together.

checkName

AuditFinding.Builder checkName(String checkName)

The audit check that generated this result.

Parameters:

checkName - The audit check that generated this result.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskStartTime

AuditFinding.Builder taskStartTime(Instant taskStartTime)

The time the audit started.

Parameters:

taskStartTime - The time the audit started.

Returns:

Returns a reference to this object so that method calls can be chained together.

findingTime

AuditFinding.Builder findingTime(Instant findingTime)

The time the result (finding) was discovered.

Parameters:

findingTime - The time the result (finding) was discovered.

Returns:

Returns a reference to this object so that method calls can be chained together.

severity

AuditFinding.Builder severity(String severity)

The severity of the result (finding).

Parameters:

severity - The severity of the result (finding).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuditFindingSeverity, AuditFindingSeverity

severity

AuditFinding.Builder severity(AuditFindingSeverity severity)

The severity of the result (finding).

Parameters:

severity - The severity of the result (finding).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuditFindingSeverity, AuditFindingSeverity

nonCompliantResource

AuditFinding.Builder nonCompliantResource(NonCompliantResource nonCompliantResource)

The resource that was found to be noncompliant with the audit check.

Parameters:

nonCompliantResource - The resource that was found to be noncompliant with the audit check.

Returns:

Returns a reference to this object so that method calls can be chained together.

nonCompliantResource

default AuditFinding.Builder nonCompliantResource(Consumer<NonCompliantResource.Builder> nonCompliantResource)

The resource that was found to be noncompliant with the audit check.

This is a convenience method that creates an instance of the NonCompliantResource.Builder avoiding the need to create one manually via NonCompliantResource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nonCompliantResource(NonCompliantResource).

Parameters:

nonCompliantResource - a consumer that will call methods on NonCompliantResource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

nonCompliantResource(NonCompliantResource)

relatedResources

AuditFinding.Builder relatedResources(Collection<RelatedResource> relatedResources)

The list of related resources.

Parameters:

relatedResources - The list of related resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedResources

AuditFinding.Builder relatedResources(RelatedResource... relatedResources)

The list of related resources.

Parameters:

relatedResources - The list of related resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedResources

AuditFinding.Builder relatedResources(Consumer<RelatedResource.Builder>... relatedResources)

The list of related resources.

This is a convenience method that creates an instance of the RelatedResource.Builder avoiding the need to create one manually via RelatedResource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #relatedResources(List).

Parameters:

relatedResources - a consumer that will call methods on RelatedResource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#relatedResources(java.util.Collection)

reasonForNonCompliance

AuditFinding.Builder reasonForNonCompliance(String reasonForNonCompliance)

The reason the resource was noncompliant.

Parameters:

reasonForNonCompliance - The reason the resource was noncompliant.

Returns:

Returns a reference to this object so that method calls can be chained together.

reasonForNonComplianceCode

AuditFinding.Builder reasonForNonComplianceCode(String reasonForNonComplianceCode)

A code that indicates the reason that the resource was noncompliant.

Parameters:

reasonForNonComplianceCode - A code that indicates the reason that the resource was noncompliant.

Returns:

Returns a reference to this object so that method calls can be chained together.

isSuppressed

AuditFinding.Builder isSuppressed(Boolean isSuppressed)

Indicates whether the audit finding was suppressed or not during reporting.

Parameters:

isSuppressed - Indicates whether the audit finding was suppressed or not during reporting.

Returns:

Returns a reference to this object so that method calls can be chained together.