AssessmentRun (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.inspector.model.AssessmentRun

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssessmentRun
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A snapshot of an Amazon Inspector assessment run that contains the findings of the assessment run .

Used as the response element in the DescribeAssessmentRuns action.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssessmentRun()

Constructors
Constructor and Description
`AssessmentRun()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssessmentRun`	`addFindingCountsEntry(String key, Integer value)`
`AssessmentRun`	`clearFindingCountsEntries()` Removes all the entries added into FindingCounts.
`AssessmentRun`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN of the assessment run.
`String`	`getAssessmentTemplateArn()` The ARN of the assessment template that is associated with the assessment run.
`Date`	`getCompletedAt()` The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
`Date`	`getCreatedAt()` The time when StartAssessmentRun was called.
`Boolean`	`getDataCollected()` A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
`Integer`	`getDurationInSeconds()` The duration of the assessment run.
`Map<String,Integer>`	`getFindingCounts()` Provides a total count of generated findings per severity.
`String`	`getName()` The auto-generated name for the assessment run.
`List<AssessmentRunNotification>`	`getNotifications()` A list of notifications for the event subscriptions.
`List<String>`	`getRulesPackageArns()` The rules packages selected for the assessment run.
`Date`	`getStartedAt()` The time when StartAssessmentRun was called.
`String`	`getState()` The state of the assessment run.
`Date`	`getStateChangedAt()` The last time when the assessment run's state changed.
`List<AssessmentRunStateChange>`	`getStateChanges()` A list of the assessment run state changes.
`List<Attribute>`	`getUserAttributesForFindings()` The user-defined attributes that are assigned to every generated finding.
`int`	`hashCode()`
`Boolean`	`isDataCollected()` A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The ARN of the assessment run.
`void`	`setAssessmentTemplateArn(String assessmentTemplateArn)` The ARN of the assessment template that is associated with the assessment run.
`void`	`setCompletedAt(Date completedAt)` The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
`void`	`setCreatedAt(Date createdAt)` The time when StartAssessmentRun was called.
`void`	`setDataCollected(Boolean dataCollected)` A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
`void`	`setDurationInSeconds(Integer durationInSeconds)` The duration of the assessment run.
`void`	`setFindingCounts(Map<String,Integer> findingCounts)` Provides a total count of generated findings per severity.
`void`	`setName(String name)` The auto-generated name for the assessment run.
`void`	`setNotifications(Collection<AssessmentRunNotification> notifications)` A list of notifications for the event subscriptions.
`void`	`setRulesPackageArns(Collection<String> rulesPackageArns)` The rules packages selected for the assessment run.
`void`	`setStartedAt(Date startedAt)` The time when StartAssessmentRun was called.
`void`	`setState(AssessmentRunState state)` The state of the assessment run.
`void`	`setState(String state)` The state of the assessment run.
`void`	`setStateChangedAt(Date stateChangedAt)` The last time when the assessment run's state changed.
`void`	`setStateChanges(Collection<AssessmentRunStateChange> stateChanges)` A list of the assessment run state changes.
`void`	`setUserAttributesForFindings(Collection<Attribute> userAttributesForFindings)` The user-defined attributes that are assigned to every generated finding.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AssessmentRun`	`withArn(String arn)` The ARN of the assessment run.
`AssessmentRun`	`withAssessmentTemplateArn(String assessmentTemplateArn)` The ARN of the assessment template that is associated with the assessment run.
`AssessmentRun`	`withCompletedAt(Date completedAt)` The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
`AssessmentRun`	`withCreatedAt(Date createdAt)` The time when StartAssessmentRun was called.
`AssessmentRun`	`withDataCollected(Boolean dataCollected)` A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
`AssessmentRun`	`withDurationInSeconds(Integer durationInSeconds)` The duration of the assessment run.
`AssessmentRun`	`withFindingCounts(Map<String,Integer> findingCounts)` Provides a total count of generated findings per severity.
`AssessmentRun`	`withName(String name)` The auto-generated name for the assessment run.
`AssessmentRun`	`withNotifications(AssessmentRunNotification... notifications)` A list of notifications for the event subscriptions.
`AssessmentRun`	`withNotifications(Collection<AssessmentRunNotification> notifications)` A list of notifications for the event subscriptions.
`AssessmentRun`	`withRulesPackageArns(Collection<String> rulesPackageArns)` The rules packages selected for the assessment run.
`AssessmentRun`	`withRulesPackageArns(String... rulesPackageArns)` The rules packages selected for the assessment run.
`AssessmentRun`	`withStartedAt(Date startedAt)` The time when StartAssessmentRun was called.
`AssessmentRun`	`withState(AssessmentRunState state)` The state of the assessment run.
`AssessmentRun`	`withState(String state)` The state of the assessment run.
`AssessmentRun`	`withStateChangedAt(Date stateChangedAt)` The last time when the assessment run's state changed.
`AssessmentRun`	`withStateChanges(AssessmentRunStateChange... stateChanges)` A list of the assessment run state changes.
`AssessmentRun`	`withStateChanges(Collection<AssessmentRunStateChange> stateChanges)` A list of the assessment run state changes.
`AssessmentRun`	`withUserAttributesForFindings(Attribute... userAttributesForFindings)` The user-defined attributes that are assigned to every generated finding.
`AssessmentRun`	`withUserAttributesForFindings(Collection<Attribute> userAttributesForFindings)` The user-defined attributes that are assigned to every generated finding.

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

- Constructor Detail
  - AssessmentRun
```
public AssessmentRun()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The ARN of the assessment run.
    
    Parameters:
    
    arn - The ARN of the assessment run.
  - getArn
```
public String getArn()
```
    The ARN of the assessment run.
    
    Returns:
    
    The ARN of the assessment run.
  - withArn
```
public AssessmentRun withArn(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.
  - setName
```
public void setName(String name)
```
    The auto-generated name for the assessment run.
    
    Parameters:
    
    name - The auto-generated name for the assessment run.
  - getName
```
public String getName()
```
    The auto-generated name for the assessment run.
    
    Returns:
    
    The auto-generated name for the assessment run.
  - withName
```
public AssessmentRun withName(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.
  - setAssessmentTemplateArn
```
public void setAssessmentTemplateArn(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.
  - getAssessmentTemplateArn
```
public String getAssessmentTemplateArn()
```
    The ARN of the assessment template that is associated with the assessment run.
    
    Returns:
    
    The ARN of the assessment template that is associated with the assessment run.
  - withAssessmentTemplateArn
```
public AssessmentRun withAssessmentTemplateArn(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.
  - setState
```
public void setState(String state)
```
    The state of the assessment run.
    
    Parameters:
    
    state - The state of the assessment run.
    
    See Also:
    
    AssessmentRunState
  - getState
```
public String getState()
```
    The state of the assessment run.
    
    Returns:
    
    The state of the assessment run.
    
    See Also:
    
    AssessmentRunState
  - withState
```
public AssessmentRun withState(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
  - setState
```
public void setState(AssessmentRunState state)
```
    The state of the assessment run.
    
    Parameters:
    
    state - The state of the assessment run.
    
    See Also:
    
    AssessmentRunState
  - withState
```
public AssessmentRun withState(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
  - setDurationInSeconds
```
public void setDurationInSeconds(Integer durationInSeconds)
```
    The duration of the assessment run.
    
    Parameters:
    
    durationInSeconds - The duration of the assessment run.
  - getDurationInSeconds
```
public Integer getDurationInSeconds()
```
    The duration of the assessment run.
    
    Returns:
    
    The duration of the assessment run.
  - withDurationInSeconds
```
public AssessmentRun withDurationInSeconds(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.
  - getRulesPackageArns
```
public List<String> getRulesPackageArns()
```
    The rules packages selected for the assessment run.
    
    Returns:
    
    The rules packages selected for the assessment run.
  - setRulesPackageArns
```
public void setRulesPackageArns(Collection<String> rulesPackageArns)
```
    The rules packages selected for the assessment run.
    
    Parameters:
    
    rulesPackageArns - The rules packages selected for the assessment run.
  - withRulesPackageArns
```
public AssessmentRun withRulesPackageArns(String... rulesPackageArns)
```
    The rules packages selected for the assessment run.
    
    NOTE: This method appends the values to the existing list (if any). Use setRulesPackageArns(java.util.Collection) or withRulesPackageArns(java.util.Collection) if you want to override the existing values.
    
    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.
  - withRulesPackageArns
```
public AssessmentRun withRulesPackageArns(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.
  - getUserAttributesForFindings
```
public List<Attribute> getUserAttributesForFindings()
```
    The user-defined attributes that are assigned to every generated finding.
    
    Returns:
    
    The user-defined attributes that are assigned to every generated finding.
  - setUserAttributesForFindings
```
public void setUserAttributesForFindings(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.
  - withUserAttributesForFindings
```
public AssessmentRun withUserAttributesForFindings(Attribute... userAttributesForFindings)
```
    The user-defined attributes that are assigned to every generated finding.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserAttributesForFindings(java.util.Collection) or withUserAttributesForFindings(java.util.Collection) if you want to override the existing values.
    
    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.
  - withUserAttributesForFindings
```
public AssessmentRun withUserAttributesForFindings(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.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time when StartAssessmentRun was called.
    
    Parameters:
    
    createdAt - The time when StartAssessmentRun was called.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time when StartAssessmentRun was called.
    
    Returns:
    
    The time when StartAssessmentRun was called.
  - withCreatedAt
```
public AssessmentRun withCreatedAt(Date 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.
  - setStartedAt
```
public void setStartedAt(Date startedAt)
```
    The time when StartAssessmentRun was called.
    
    Parameters:
    
    startedAt - The time when StartAssessmentRun was called.
  - getStartedAt
```
public Date getStartedAt()
```
    The time when StartAssessmentRun was called.
    
    Returns:
    
    The time when StartAssessmentRun was called.
  - withStartedAt
```
public AssessmentRun withStartedAt(Date 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.
  - setCompletedAt
```
public void setCompletedAt(Date 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.
  - getCompletedAt
```
public Date getCompletedAt()
```
    The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
    
    Returns:
    
    The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
  - withCompletedAt
```
public AssessmentRun withCompletedAt(Date 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.
  - setStateChangedAt
```
public void setStateChangedAt(Date stateChangedAt)
```
    The last time when the assessment run's state changed.
    
    Parameters:
    
    stateChangedAt - The last time when the assessment run's state changed.
  - getStateChangedAt
```
public Date getStateChangedAt()
```
    The last time when the assessment run's state changed.
    
    Returns:
    
    The last time when the assessment run's state changed.
  - withStateChangedAt
```
public AssessmentRun withStateChangedAt(Date 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.
  - setDataCollected
```
public void setDataCollected(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.
  - getDataCollected
```
public Boolean getDataCollected()
```
    A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
    
    Returns:
    
    A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
  - withDataCollected
```
public AssessmentRun withDataCollected(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.
  - isDataCollected
```
public Boolean isDataCollected()
```
    A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
    
    Returns:
    
    A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
  - getStateChanges
```
public List<AssessmentRunStateChange> getStateChanges()
```
    A list of the assessment run state changes.
    
    Returns:
    
    A list of the assessment run state changes.
  - setStateChanges
```
public void setStateChanges(Collection<AssessmentRunStateChange> stateChanges)
```
    A list of the assessment run state changes.
    
    Parameters:
    
    stateChanges - A list of the assessment run state changes.
  - withStateChanges
```
public AssessmentRun withStateChanges(AssessmentRunStateChange... stateChanges)
```
    A list of the assessment run state changes.
    
    NOTE: This method appends the values to the existing list (if any). Use setStateChanges(java.util.Collection) or withStateChanges(java.util.Collection) if you want to override the existing values.
    
    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.
  - withStateChanges
```
public AssessmentRun withStateChanges(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.
  - getNotifications
```
public List<AssessmentRunNotification> getNotifications()
```
    A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
    
    Returns:
    
    A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
  - setNotifications
```
public void setNotifications(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.
  - withNotifications
```
public AssessmentRun withNotifications(AssessmentRunNotification... notifications)
```
    A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotifications(java.util.Collection) or withNotifications(java.util.Collection) if you want to override the existing values.
    
    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.
  - withNotifications
```
public AssessmentRun withNotifications(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.
  - getFindingCounts
```
public Map<String,Integer> getFindingCounts()
```
    Provides a total count of generated findings per severity.
    
    Returns:
    
    Provides a total count of generated findings per severity.
  - setFindingCounts
```
public void setFindingCounts(Map<String,Integer> findingCounts)
```
    Provides a total count of generated findings per severity.
    
    Parameters:
    
    findingCounts - Provides a total count of generated findings per severity.
  - withFindingCounts
```
public AssessmentRun withFindingCounts(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.
  - addFindingCountsEntry
```
public AssessmentRun addFindingCountsEntry(String key,
                                           Integer value)
```
  - clearFindingCountsEntries
```
public AssessmentRun clearFindingCountsEntries()
```
    Removes all the entries added into FindingCounts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AssessmentRun clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AssessmentRun

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssessmentRun

Method Detail

setArn

getArn

withArn

setName

getName

withName

setAssessmentTemplateArn

getAssessmentTemplateArn

withAssessmentTemplateArn

setState

getState

withState

setState

withState

setDurationInSeconds

getDurationInSeconds

withDurationInSeconds

getRulesPackageArns

setRulesPackageArns

withRulesPackageArns

withRulesPackageArns

getUserAttributesForFindings

setUserAttributesForFindings

withUserAttributesForFindings

withUserAttributesForFindings

setCreatedAt

getCreatedAt

withCreatedAt

setStartedAt

getStartedAt

withStartedAt

setCompletedAt

getCompletedAt

withCompletedAt

setStateChangedAt

getStateChangedAt

withStateChangedAt

setDataCollected

getDataCollected

withDataCollected

isDataCollected

getStateChanges

setStateChanges

withStateChanges

withStateChanges

getNotifications

setNotifications

withNotifications

withNotifications

getFindingCounts

setFindingCounts

withFindingCounts

addFindingCountsEntry

clearFindingCountsEntries

toString

equals

hashCode

clone

marshall