Assessment (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class Assessment
extends Object
implements Serializable, Cloneable
```
Contains information about an Inspector assessment.

This data type is used as the response element in the DescribeAssessment action.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Assessment()

Constructors
Constructor and Description
`Assessment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Assessment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationArn()` The ARN of the application that corresponds to this assessment.
`String`	`getAssessmentArn()` The ARN of the assessment.
`String`	`getAssessmentName()` The name of the assessment.
`String`	`getAssessmentState()` The state of the assessment.
`Boolean`	`getDataCollected()` Boolean value (true or false) specifying whether the data collection process is completed.
`Integer`	`getDurationInSeconds()` The assessment duration in seconds.
`Date`	`getEndTime()` The assessment end time.
`String`	`getFailureMessage()` This data type property is not currently used.
`Date`	`getStartTime()` The assessment start time.
`List<Attribute>`	`getUserAttributesForFindings()` The user-defined attributes that are assigned to every generated finding.
`int`	`hashCode()`
`Boolean`	`isDataCollected()` Boolean value (true or false) specifying whether the data collection process is completed.
`void`	`setApplicationArn(String applicationArn)` The ARN of the application that corresponds to this assessment.
`void`	`setAssessmentArn(String assessmentArn)` The ARN of the assessment.
`void`	`setAssessmentName(String assessmentName)` The name of the assessment.
`void`	`setAssessmentState(String assessmentState)` The state of the assessment.
`void`	`setDataCollected(Boolean dataCollected)` Boolean value (true or false) specifying whether the data collection process is completed.
`void`	`setDurationInSeconds(Integer durationInSeconds)` The assessment duration in seconds.
`void`	`setEndTime(Date endTime)` The assessment end time.
`void`	`setFailureMessage(String failureMessage)` This data type property is not currently used.
`void`	`setStartTime(Date startTime)` The assessment start time.
`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.
`Assessment`	`withApplicationArn(String applicationArn)` The ARN of the application that corresponds to this assessment.
`Assessment`	`withAssessmentArn(String assessmentArn)` The ARN of the assessment.
`Assessment`	`withAssessmentName(String assessmentName)` The name of the assessment.
`Assessment`	`withAssessmentState(String assessmentState)` The state of the assessment.
`Assessment`	`withDataCollected(Boolean dataCollected)` Boolean value (true or false) specifying whether the data collection process is completed.
`Assessment`	`withDurationInSeconds(Integer durationInSeconds)` The assessment duration in seconds.
`Assessment`	`withEndTime(Date endTime)` The assessment end time.
`Assessment`	`withFailureMessage(String failureMessage)` This data type property is not currently used.
`Assessment`	`withStartTime(Date startTime)` The assessment start time.
`Assessment`	`withUserAttributesForFindings(Attribute... userAttributesForFindings)` The user-defined attributes that are assigned to every generated finding.
`Assessment`	`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
  - Assessment
```
public Assessment()
```
- Method Detail
  - setAssessmentArn
```
public void setAssessmentArn(String assessmentArn)
```
    The ARN of the assessment.
    
    Parameters:
    
    assessmentArn - The ARN of the assessment.
  - getAssessmentArn
```
public String getAssessmentArn()
```
    The ARN of the assessment.
    
    Returns:
    
    The ARN of the assessment.
  - withAssessmentArn
```
public Assessment withAssessmentArn(String assessmentArn)
```
    The ARN of the assessment.
    
    Parameters:
    
    assessmentArn - The ARN of the assessment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssessmentName
```
public void setAssessmentName(String assessmentName)
```
    The name of the assessment.
    
    Parameters:
    
    assessmentName - The name of the assessment.
  - getAssessmentName
```
public String getAssessmentName()
```
    The name of the assessment.
    
    Returns:
    
    The name of the assessment.
  - withAssessmentName
```
public Assessment withAssessmentName(String assessmentName)
```
    The name of the assessment.
    
    Parameters:
    
    assessmentName - The name of the assessment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApplicationArn
```
public void setApplicationArn(String applicationArn)
```
    The ARN of the application that corresponds to this assessment.
    
    Parameters:
    
    applicationArn - The ARN of the application that corresponds to this assessment.
  - getApplicationArn
```
public String getApplicationArn()
```
    The ARN of the application that corresponds to this assessment.
    
    Returns:
    
    The ARN of the application that corresponds to this assessment.
  - withApplicationArn
```
public Assessment withApplicationArn(String applicationArn)
```
    The ARN of the application that corresponds to this assessment.
    
    Parameters:
    
    applicationArn - The ARN of the application that corresponds to this assessment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssessmentState
```
public void setAssessmentState(String assessmentState)
```
    The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
    
    Parameters:
    
    assessmentState - The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
  - getAssessmentState
```
public String getAssessmentState()
```
    The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
    
    Returns:
    
    The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
  - withAssessmentState
```
public Assessment withAssessmentState(String assessmentState)
```
    The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
    
    Parameters:
    
    assessmentState - The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureMessage
```
public void setFailureMessage(String failureMessage)
```
    This data type property is not currently used.
    
    Parameters:
    
    failureMessage - This data type property is not currently used.
  - getFailureMessage
```
public String getFailureMessage()
```
    This data type property is not currently used.
    
    Returns:
    
    This data type property is not currently used.
  - withFailureMessage
```
public Assessment withFailureMessage(String failureMessage)
```
    This data type property is not currently used.
    
    Parameters:
    
    failureMessage - This data type property is not currently used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataCollected
```
public void setDataCollected(Boolean dataCollected)
```
    Boolean value (true or false) specifying whether the data collection process is completed.
    
    Parameters:
    
    dataCollected - Boolean value (true or false) specifying whether the data collection process is completed.
  - getDataCollected
```
public Boolean getDataCollected()
```
    Boolean value (true or false) specifying whether the data collection process is completed.
    
    Returns:
    
    Boolean value (true or false) specifying whether the data collection process is completed.
  - withDataCollected
```
public Assessment withDataCollected(Boolean dataCollected)
```
    Boolean value (true or false) specifying whether the data collection process is completed.
    
    Parameters:
    
    dataCollected - Boolean value (true or false) specifying whether the data collection process is completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDataCollected
```
public Boolean isDataCollected()
```
    Boolean value (true or false) specifying whether the data collection process is completed.
    
    Returns:
    
    Boolean value (true or false) specifying whether the data collection process is completed.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The assessment start time.
    
    Parameters:
    
    startTime - The assessment start time.
  - getStartTime
```
public Date getStartTime()
```
    The assessment start time.
    
    Returns:
    
    The assessment start time.
  - withStartTime
```
public Assessment withStartTime(Date startTime)
```
    The assessment start time.
    
    Parameters:
    
    startTime - The assessment start time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The assessment end time.
    
    Parameters:
    
    endTime - The assessment end time.
  - getEndTime
```
public Date getEndTime()
```
    The assessment end time.
    
    Returns:
    
    The assessment end time.
  - withEndTime
```
public Assessment withEndTime(Date endTime)
```
    The assessment end time.
    
    Parameters:
    
    endTime - The assessment end time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDurationInSeconds
```
public void setDurationInSeconds(Integer durationInSeconds)
```
    The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
    
    Parameters:
    
    durationInSeconds - The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
  - getDurationInSeconds
```
public Integer getDurationInSeconds()
```
    The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
    
    Returns:
    
    The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
  - withDurationInSeconds
```
public Assessment withDurationInSeconds(Integer durationInSeconds)
```
    The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
    
    Parameters:
    
    durationInSeconds - The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
    
    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 Assessment 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 Assessment 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.
  - 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 Assessment clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Assessment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Assessment

Method Detail

setAssessmentArn

getAssessmentArn

withAssessmentArn

setAssessmentName

getAssessmentName

withAssessmentName

setApplicationArn

getApplicationArn

withApplicationArn

setAssessmentState

getAssessmentState

withAssessmentState

setFailureMessage

getFailureMessage

withFailureMessage

setDataCollected

getDataCollected

withDataCollected

isDataCollected

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setDurationInSeconds

getDurationInSeconds

withDurationInSeconds

getUserAttributesForFindings

setUserAttributesForFindings

withUserAttributesForFindings

withUserAttributesForFindings

toString

equals

hashCode

clone