AssessmentRun (AWS Java SDK :: Services :: Amazon Inspector Service 2.20.95 API)

java.lang.Object
- software.amazon.awssdk.services.inspector.model.AssessmentRun

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssessmentRun.Builder,AssessmentRun>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AssessmentRun
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssessmentRun.Builder,AssessmentRun>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AssessmentRun.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AssessmentRun.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the assessment run.
`String`	`assessmentTemplateArn()` The ARN of the assessment template that is associated with the assessment run.
`static AssessmentRun.Builder`	`builder()`
`Instant`	`completedAt()` The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
`Instant`	`createdAt()` The time when StartAssessmentRun was called.
`Boolean`	`dataCollected()` A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
`Integer`	`durationInSeconds()` The duration of the assessment run.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<Severity,Integer>`	`findingCounts()` Provides a total count of generated findings per severity.
`Map<String,Integer>`	`findingCountsAsStrings()` Provides a total count of generated findings per severity.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFindingCounts()` For responses, this returns true if the service returned a value for the FindingCounts property.
`int`	`hashCode()`
`boolean`	`hasNotifications()` For responses, this returns true if the service returned a value for the Notifications property.
`boolean`	`hasRulesPackageArns()` For responses, this returns true if the service returned a value for the RulesPackageArns property.
`boolean`	`hasStateChanges()` For responses, this returns true if the service returned a value for the StateChanges property.
`boolean`	`hasUserAttributesForFindings()` For responses, this returns true if the service returned a value for the UserAttributesForFindings property.
`String`	`name()` The auto-generated name for the assessment run.
`List<AssessmentRunNotification>`	`notifications()` A list of notifications for the event subscriptions.
`List<String>`	`rulesPackageArns()` The rules packages selected for the assessment run.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AssessmentRun.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The time when StartAssessmentRun was called.
`AssessmentRunState`	`state()` The state of the assessment run.
`String`	`stateAsString()` The state of the assessment run.
`Instant`	`stateChangedAt()` The last time when the assessment run's state changed.
`List<AssessmentRunStateChange>`	`stateChanges()` A list of the assessment run state changes.
`AssessmentRun.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<Attribute>`	`userAttributesForFindings()` The user-defined attributes that are assigned to every generated finding.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The ARN of the assessment run.
    
    Returns:
    
    The ARN of the assessment run.
  - name
```
public final String name()
```
    The auto-generated name for the assessment run.
    
    Returns:
    
    The auto-generated name for the assessment run.
  - assessmentTemplateArn
```
public final String assessmentTemplateArn()
```
    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.
  - state
```
public final AssessmentRunState state()
```
    The state of the assessment run.
    
    If the service returns an enum value that is not available in the current SDK version, state will return AssessmentRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the assessment run.
    
    See Also:
    
    AssessmentRunState
  - stateAsString
```
public final String stateAsString()
```
    The state of the assessment run.
    
    If the service returns an enum value that is not available in the current SDK version, state will return AssessmentRunState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the assessment run.
    
    See Also:
    
    AssessmentRunState
  - durationInSeconds
```
public final Integer durationInSeconds()
```
    The duration of the assessment run.
    
    Returns:
    
    The duration of the assessment run.
  - hasRulesPackageArns
```
public final boolean hasRulesPackageArns()
```
    For responses, this returns true if the service returned a value for the RulesPackageArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - rulesPackageArns
```
public final List<String> rulesPackageArns()
```
    The rules packages selected for the assessment run.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRulesPackageArns() method.
    
    Returns:
    
    The rules packages selected for the assessment run.
  - hasUserAttributesForFindings
```
public final boolean hasUserAttributesForFindings()
```
    For responses, this returns true if the service returned a value for the UserAttributesForFindings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - userAttributesForFindings
```
public final List<Attribute> userAttributesForFindings()
```
    The user-defined attributes that are assigned to every generated finding.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAttributesForFindings() method.
    
    Returns:
    
    The user-defined attributes that are assigned to every generated finding.
  - createdAt
```
public final Instant createdAt()
```
    The time when StartAssessmentRun was called.
    
    Returns:
    
    The time when StartAssessmentRun was called.
  - startedAt
```
public final Instant startedAt()
```
    The time when StartAssessmentRun was called.
    
    Returns:
    
    The time when StartAssessmentRun was called.
  - completedAt
```
public final Instant completedAt()
```
    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.
  - stateChangedAt
```
public final Instant stateChangedAt()
```
    The last time when the assessment run's state changed.
    
    Returns:
    
    The last time when the assessment run's state changed.
  - dataCollected
```
public final Boolean dataCollected()
```
    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.
  - hasStateChanges
```
public final boolean hasStateChanges()
```
    For responses, this returns true if the service returned a value for the StateChanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - stateChanges
```
public final List<AssessmentRunStateChange> stateChanges()
```
    A list of the assessment run state changes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStateChanges() method.
    
    Returns:
    
    A list of the assessment run state changes.
  - hasNotifications
```
public final boolean hasNotifications()
```
    For responses, this returns true if the service returned a value for the Notifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - notifications
```
public final List<AssessmentRunNotification> notifications()
```
    A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotifications() method.
    
    Returns:
    
    A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
  - findingCounts
```
public final Map<Severity,Integer> findingCounts()
```
    Provides a total count of generated findings per severity.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFindingCounts() method.
    
    Returns:
    
    Provides a total count of generated findings per severity.
  - hasFindingCounts
```
public final boolean hasFindingCounts()
```
    For responses, this returns true if the service returned a value for the FindingCounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - findingCountsAsStrings
```
public final Map<String,Integer> findingCountsAsStrings()
```
    Provides a total count of generated findings per severity.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFindingCounts() method.
    
    Returns:
    
    Provides a total count of generated findings per severity.
  - toBuilder
```
public AssessmentRun.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AssessmentRun.Builder,AssessmentRun>
  - builder
```
public static AssessmentRun.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssessmentRun.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AssessmentRun

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

assessmentTemplateArn

state

stateAsString

durationInSeconds

hasRulesPackageArns

rulesPackageArns

hasUserAttributesForFindings

userAttributesForFindings

createdAt

startedAt

completedAt

stateChangedAt

dataCollected

hasStateChanges

stateChanges

hasNotifications

notifications

findingCounts

hasFindingCounts

findingCountsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields