Interface AssessmentRun.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AssessmentRun.Builder,
,AssessmentRun> SdkBuilder<AssessmentRun.Builder,
,AssessmentRun> SdkPojo
- Enclosing class:
AssessmentRun
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the assessment run.assessmentTemplateArn
(String assessmentTemplateArn) The ARN of the assessment template that is associated with the assessment run.completedAt
(Instant completedAt) The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.The time when StartAssessmentRun was called.dataCollected
(Boolean dataCollected) A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.durationInSeconds
(Integer durationInSeconds) The duration of the assessment run.findingCounts
(Map<Severity, Integer> findingCounts) Provides a total count of generated findings per severity.findingCountsWithStrings
(Map<String, Integer> findingCounts) Provides a total count of generated findings per severity.The auto-generated name for the assessment run.notifications
(Collection<AssessmentRunNotification> notifications) A list of notifications for the event subscriptions.notifications
(Consumer<AssessmentRunNotification.Builder>... notifications) A list of notifications for the event subscriptions.notifications
(AssessmentRunNotification... notifications) A list of notifications for the event subscriptions.rulesPackageArns
(String... rulesPackageArns) The rules packages selected for the assessment run.rulesPackageArns
(Collection<String> rulesPackageArns) The rules packages selected for the assessment run.The time when StartAssessmentRun was called.The state of the assessment run.state
(AssessmentRunState state) The state of the assessment run.stateChangedAt
(Instant stateChangedAt) The last time when the assessment run's state changed.stateChanges
(Collection<AssessmentRunStateChange> stateChanges) A list of the assessment run state changes.stateChanges
(Consumer<AssessmentRunStateChange.Builder>... stateChanges) A list of the assessment run state changes.stateChanges
(AssessmentRunStateChange... stateChanges) A list of the assessment run state changes.userAttributesForFindings
(Collection<Attribute> userAttributesForFindings) The user-defined attributes that are assigned to every generated finding.userAttributesForFindings
(Consumer<Attribute.Builder>... userAttributesForFindings) The user-defined attributes that are assigned to every generated finding.userAttributesForFindings
(Attribute... userAttributesForFindings) The user-defined attributes that are assigned to every generated finding.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, sdkFields
-
Method Details
-
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
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
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
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:
-
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:
-
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
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
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
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
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 theAttribute.Builder
avoiding the need to create one manually viaAttribute.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserAttributesForFindings(List<Attribute>)
.- Parameters:
userAttributesForFindings
- a consumer that will call methods onAttribute.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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
A list of the assessment run state changes.
This is a convenience method that creates an instance of theAssessmentRunStateChange.Builder
avoiding the need to create one manually viaAssessmentRunStateChange.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostateChanges(List<AssessmentRunStateChange>)
.- Parameters:
stateChanges
- a consumer that will call methods onAssessmentRunStateChange.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theAssessmentRunNotification.Builder
avoiding the need to create one manually viaAssessmentRunNotification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotifications(List<AssessmentRunNotification>)
.- Parameters:
notifications
- a consumer that will call methods onAssessmentRunNotification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
findingCountsWithStrings
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
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.
-