Class DetectMitigationActionsTaskSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DetectMitigationActionsTaskSummary.Builder,
DetectMitigationActionsTaskSummary>
The summary of the mitigation action tasks.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<MitigationAction> The definition of the actions.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 ActionsDefinition property.final int
hashCode()
final Boolean
Includes only active violations.static Class
<? extends DetectMitigationActionsTaskSummary.Builder> final Boolean
Includes suppressed alerts.target()
Specifies the ML Detect findings to which the mitigation actions are applied.final Instant
The date the task ended.final String
taskId()
The unique identifier of the task.final Instant
The date the task started.The statistics of a mitigation action task.The status of the task.final String
The status of the task.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.Specifies the time period of which violation events occurred between.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
taskId
The unique identifier of the task.
- Returns:
- The unique identifier of the task.
-
taskStatus
The status of the task.
If the service returns an enum value that is not available in the current SDK version,
taskStatus
will returnDetectMitigationActionsTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskStatusAsString()
.- Returns:
- The status of the task.
- See Also:
-
taskStatusAsString
The status of the task.
If the service returns an enum value that is not available in the current SDK version,
taskStatus
will returnDetectMitigationActionsTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskStatusAsString()
.- Returns:
- The status of the task.
- See Also:
-
taskStartTime
The date the task started.
- Returns:
- The date the task started.
-
taskEndTime
The date the task ended.
- Returns:
- The date the task ended.
-
target
Specifies the ML Detect findings to which the mitigation actions are applied.
- Returns:
- Specifies the ML Detect findings to which the mitigation actions are applied.
-
violationEventOccurrenceRange
Specifies the time period of which violation events occurred between.
- Returns:
- Specifies the time period of which violation events occurred between.
-
onlyActiveViolationsIncluded
Includes only active violations.
- Returns:
- Includes only active violations.
-
suppressedAlertsIncluded
Includes suppressed alerts.
- Returns:
- Includes suppressed alerts.
-
hasActionsDefinition
public final boolean hasActionsDefinition()For responses, this returns true if the service returned a value for the ActionsDefinition 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. -
actionsDefinition
The definition of the actions.
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
hasActionsDefinition()
method.- Returns:
- The definition of the actions.
-
taskStatistics
The statistics of a mitigation action task.
- Returns:
- The statistics of a mitigation action task.
-
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<DetectMitigationActionsTaskSummary.Builder,
DetectMitigationActionsTaskSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DetectMitigationActionsTaskSummary.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
-