Class AssessmentRun
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the assessment run.final String
The ARN of the assessment template that is associated with the assessment run.static AssessmentRun.Builder
builder()
final Instant
The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.final Instant
The time when StartAssessmentRun was called.final Boolean
A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.final Integer
The duration of the assessment run.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Provides a total count of generated findings per severity.Provides a total count of generated findings per severity.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FindingCounts property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Notifications property.final boolean
For responses, this returns true if the service returned a value for the RulesPackageArns property.final boolean
For responses, this returns true if the service returned a value for the StateChanges property.final boolean
For responses, this returns true if the service returned a value for the UserAttributesForFindings property.final String
name()
The auto-generated name for the assessment run.final List
<AssessmentRunNotification> A list of notifications for the event subscriptions.The rules packages selected for the assessment run.static Class
<? extends AssessmentRun.Builder> final Instant
The time when StartAssessmentRun was called.final AssessmentRunState
state()
The state of the assessment run.final String
The state of the assessment run.final Instant
The last time when the assessment run's state changed.final List
<AssessmentRunStateChange> A list of the assessment run state changes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The user-defined attributes that are assigned to every generated finding.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The ARN of the assessment run.
- Returns:
- The ARN of the assessment run.
-
name
The auto-generated name for the assessment run.
- Returns:
- The auto-generated name for the assessment run.
-
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
The state of the assessment run.
If the service returns an enum value that is not available in the current SDK version,
state
will returnAssessmentRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the assessment run.
- See Also:
-
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 returnAssessmentRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the assessment run.
- See Also:
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The time when StartAssessmentRun was called.
- Returns:
- The time when StartAssessmentRun was called.
-
startedAt
The time when StartAssessmentRun was called.
- Returns:
- The time when StartAssessmentRun was called.
-
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
The last time when the assessment run's state changed.
- Returns:
- The last time when the assessment run's state changed.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssessmentRun.Builder,
AssessmentRun> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-