software.amazon.awssdk.services.iot.model

Class DetectMitigationActionsTaskSummary

java.lang.Object

software.amazon.awssdk.services.iot.model.DetectMitigationActionsTaskSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DetectMitigationActionsTaskSummary.Builder,DetectMitigationActionsTaskSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class DetectMitigationActionsTaskSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DetectMitigationActionsTaskSummary.Builder,DetectMitigationActionsTaskSummary>

The summary of the mitigation action tasks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectMitigationActionsTaskSummary.Builder

Method Summary

Modifier and Type	Method and Description
List<MitigationAction>	actionsDefinition() The definition of the actions.
static DetectMitigationActionsTaskSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActionsDefinition() For responses, this returns true if the service returned a value for the ActionsDefinition property.
int	hashCode()
Boolean	onlyActiveViolationsIncluded() Includes only active violations.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectMitigationActionsTaskSummary.Builder>	serializableBuilderClass()
Boolean	suppressedAlertsIncluded() Includes suppressed alerts.
DetectMitigationActionsTaskTarget	target() Specifies the ML Detect findings to which the mitigation actions are applied.
Instant	taskEndTime() The date the task ended.
String	taskId() The unique identifier of the task.
Instant	taskStartTime() The date the task started.
DetectMitigationActionsTaskStatistics	taskStatistics() The statistics of a mitigation action task.
DetectMitigationActionsTaskStatus	taskStatus() The status of the task.
String	taskStatusAsString() The status of the task.
DetectMitigationActionsTaskSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ViolationEventOccurrenceRange	violationEventOccurrenceRange() Specifies the time period of which violation events occurred between.

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

taskId

public final String taskId()

The unique identifier of the task.

Returns:

The unique identifier of the task.

taskStatus

public final DetectMitigationActionsTaskStatus taskStatus()

The status of the task.

If the service returns an enum value that is not available in the current SDK version, taskStatus will return DetectMitigationActionsTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskStatusAsString().

Returns:

The status of the task.

See Also:

DetectMitigationActionsTaskStatus

taskStatusAsString

public final String taskStatusAsString()

The status of the task.

If the service returns an enum value that is not available in the current SDK version, taskStatus will return DetectMitigationActionsTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskStatusAsString().

Returns:

The status of the task.

See Also:

DetectMitigationActionsTaskStatus

taskStartTime

public final Instant taskStartTime()

The date the task started.

Returns:

The date the task started.

taskEndTime

public final Instant taskEndTime()

The date the task ended.

Returns:

The date the task ended.

target

public final DetectMitigationActionsTaskTarget 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

public final ViolationEventOccurrenceRange violationEventOccurrenceRange()

Specifies the time period of which violation events occurred between.

Returns:

Specifies the time period of which violation events occurred between.

onlyActiveViolationsIncluded

public final Boolean onlyActiveViolationsIncluded()

Includes only active violations.

Returns:

Includes only active violations.

suppressedAlertsIncluded

public final Boolean 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 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.

actionsDefinition

public final List<MitigationAction> 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

public final DetectMitigationActionsTaskStatistics taskStatistics()

The statistics of a mitigation action task.

Returns:

The statistics of a mitigation action task.

toBuilder

public DetectMitigationActionsTaskSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectMitigationActionsTaskSummary.Builder,DetectMitigationActionsTaskSummary>

builder

public static DetectMitigationActionsTaskSummary.Builder builder()

serializableBuilderClass

public static Class<? extends DetectMitigationActionsTaskSummary.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