software.amazon.awssdk.services.inspector.model

Interface AssessmentRun.Builder

All Superinterfaces:

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

Enclosing class:

AssessmentRun

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

Method Summary

Modifier and Type	Method and Description
AssessmentRun.Builder	arn(String arn) The ARN of the assessment run.
AssessmentRun.Builder	assessmentTemplateArn(String assessmentTemplateArn) The ARN of the assessment template that is associated with the assessment run.
AssessmentRun.Builder	completedAt(Instant completedAt) The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
AssessmentRun.Builder	createdAt(Instant createdAt) The time when StartAssessmentRun was called.
AssessmentRun.Builder	dataCollected(Boolean dataCollected) A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
AssessmentRun.Builder	durationInSeconds(Integer durationInSeconds) The duration of the assessment run.
AssessmentRun.Builder	findingCounts(Map<Severity,Integer> findingCounts) Provides a total count of generated findings per severity.
AssessmentRun.Builder	findingCountsWithStrings(Map<String,Integer> findingCounts) Provides a total count of generated findings per severity.
AssessmentRun.Builder	name(String name) The auto-generated name for the assessment run.
AssessmentRun.Builder	notifications(AssessmentRunNotification... notifications) A list of notifications for the event subscriptions.
AssessmentRun.Builder	notifications(Collection<AssessmentRunNotification> notifications) A list of notifications for the event subscriptions.
AssessmentRun.Builder	notifications(Consumer<AssessmentRunNotification.Builder>... notifications) A list of notifications for the event subscriptions.
AssessmentRun.Builder	rulesPackageArns(Collection<String> rulesPackageArns) The rules packages selected for the assessment run.
AssessmentRun.Builder	rulesPackageArns(String... rulesPackageArns) The rules packages selected for the assessment run.
AssessmentRun.Builder	startedAt(Instant startedAt) The time when StartAssessmentRun was called.
AssessmentRun.Builder	state(AssessmentRunState state) The state of the assessment run.
AssessmentRun.Builder	state(String state) The state of the assessment run.
AssessmentRun.Builder	stateChangedAt(Instant stateChangedAt) The last time when the assessment run's state changed.
AssessmentRun.Builder	stateChanges(AssessmentRunStateChange... stateChanges) A list of the assessment run state changes.
AssessmentRun.Builder	stateChanges(Collection<AssessmentRunStateChange> stateChanges) A list of the assessment run state changes.
AssessmentRun.Builder	stateChanges(Consumer<AssessmentRunStateChange.Builder>... stateChanges) A list of the assessment run state changes.
AssessmentRun.Builder	userAttributesForFindings(Attribute... userAttributesForFindings) The user-defined attributes that are assigned to every generated finding.
AssessmentRun.Builder	userAttributesForFindings(Collection<Attribute> userAttributesForFindings) The user-defined attributes that are assigned to every generated finding.
AssessmentRun.Builder	userAttributesForFindings(Consumer<Attribute.Builder>... userAttributesForFindings) The user-defined attributes that are assigned to every generated finding.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

arn

AssessmentRun.Builder arn(String arn)

The ARN of the assessment run.

Parameters:

arn - The ARN of the assessment run.

Returns:

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

name

AssessmentRun.Builder name(String name)

The auto-generated name for the assessment run.

Parameters:

name - The auto-generated name for the assessment run.

Returns:

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

assessmentTemplateArn

AssessmentRun.Builder assessmentTemplateArn(String assessmentTemplateArn)

The ARN of the assessment template that is associated with the assessment run.

Parameters:

assessmentTemplateArn - The ARN of the assessment template that is associated with the assessment run.

Returns:

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

state

AssessmentRun.Builder state(String state)

The state of the assessment run.

Parameters:

state - The state of the assessment run.

Returns:

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

See Also:

AssessmentRunState, AssessmentRunState

state

AssessmentRun.Builder state(AssessmentRunState state)

The state of the assessment run.

Parameters:

state - The state of the assessment run.

Returns:

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

See Also:

AssessmentRunState, AssessmentRunState

durationInSeconds

AssessmentRun.Builder durationInSeconds(Integer durationInSeconds)

The duration of the assessment run.

Parameters:

durationInSeconds - The duration of the assessment run.

Returns:

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

rulesPackageArns

AssessmentRun.Builder rulesPackageArns(Collection<String> rulesPackageArns)

The rules packages selected for the assessment run.

Parameters:

rulesPackageArns - The rules packages selected for the assessment run.

Returns:

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

rulesPackageArns

AssessmentRun.Builder rulesPackageArns(String... rulesPackageArns)

The rules packages selected for the assessment run.

Parameters:

rulesPackageArns - The rules packages selected for the assessment run.

Returns:

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

userAttributesForFindings

AssessmentRun.Builder userAttributesForFindings(Collection<Attribute> userAttributesForFindings)

The user-defined attributes that are assigned to every generated finding.

Parameters:

userAttributesForFindings - The user-defined attributes that are assigned to every generated finding.

Returns:

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

userAttributesForFindings

AssessmentRun.Builder userAttributesForFindings(Attribute... userAttributesForFindings)

The user-defined attributes that are assigned to every generated finding.

Parameters:

userAttributesForFindings - The user-defined attributes that are assigned to every generated finding.

Returns:

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

userAttributesForFindings

AssessmentRun.Builder userAttributesForFindings(Consumer<Attribute.Builder>... userAttributesForFindings)

The user-defined attributes that are assigned to every generated finding.

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

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

Parameters:

userAttributesForFindings - a consumer that will call methods on Attribute.Builder

Returns:

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

See Also:

#userAttributesForFindings(java.util.Collection)

createdAt

AssessmentRun.Builder createdAt(Instant createdAt)

The time when StartAssessmentRun was called.

Parameters:

createdAt - The time when StartAssessmentRun was called.

Returns:

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

startedAt

AssessmentRun.Builder startedAt(Instant startedAt)

The time when StartAssessmentRun was called.

Parameters:

startedAt - The time when StartAssessmentRun was called.

Returns:

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

completedAt

AssessmentRun.Builder completedAt(Instant completedAt)

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

Parameters:

completedAt - The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

Returns:

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

stateChangedAt

AssessmentRun.Builder stateChangedAt(Instant stateChangedAt)

The last time when the assessment run's state changed.

Parameters:

stateChangedAt - The last time when the assessment run's state changed.

Returns:

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

dataCollected

AssessmentRun.Builder dataCollected(Boolean dataCollected)

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

Parameters:

dataCollected - A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

Returns:

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

stateChanges

AssessmentRun.Builder stateChanges(Collection<AssessmentRunStateChange> stateChanges)

A list of the assessment run state changes.

Parameters:

stateChanges - A list of the assessment run state changes.

Returns:

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

stateChanges

AssessmentRun.Builder stateChanges(AssessmentRunStateChange... stateChanges)

A list of the assessment run state changes.

Parameters:

stateChanges - A list of the assessment run state changes.

Returns:

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

stateChanges

AssessmentRun.Builder stateChanges(Consumer<AssessmentRunStateChange.Builder>... stateChanges)

A list of the assessment run state changes.

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

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

Parameters:

stateChanges - a consumer that will call methods on AssessmentRunStateChange.Builder

Returns:

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

See Also:

#stateChanges(java.util.Collection)

notifications

AssessmentRun.Builder notifications(Collection<AssessmentRunNotification> notifications)

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

Parameters:

notifications - A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

Returns:

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

notifications

AssessmentRun.Builder notifications(AssessmentRunNotification... notifications)

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

Parameters:

notifications - A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

Returns:

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

notifications

AssessmentRun.Builder notifications(Consumer<AssessmentRunNotification.Builder>... notifications)

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

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

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

Parameters:

notifications - a consumer that will call methods on AssessmentRunNotification.Builder

Returns:

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

See Also:

#notifications(java.util.Collection)

findingCountsWithStrings

AssessmentRun.Builder findingCountsWithStrings(Map<String,Integer> findingCounts)

Provides a total count of generated findings per severity.

Parameters:

findingCounts - Provides a total count of generated findings per severity.

Returns:

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

findingCounts

AssessmentRun.Builder findingCounts(Map<Severity,Integer> findingCounts)

Provides a total count of generated findings per severity.

Parameters:

findingCounts - Provides a total count of generated findings per severity.

Returns:

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