Package software.amazon.awssdk.services.iot.model

Class StartDetectMitigationActionsTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.StartDetectMitigationActionsTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDetectMitigationActionsTaskRequest.Builder,StartDetectMitigationActionsTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartDetectMitigationActionsTaskRequest
extends IotRequest
implements ToCopyableBuilder<StartDetectMitigationActionsTaskRequest.Builder,StartDetectMitigationActionsTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartDetectMitigationActionsTaskRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	actions()	The actions to be performed when a device has unexpected behavior.
static StartDetectMitigationActionsTaskRequest.Builder	builder()
String	clientRequestToken()	Each mitigation action task must have a unique client request token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions()	For responses, this returns true if the service returned a value for the Actions property.
int	hashCode()
Boolean	includeOnlyActiveViolations()	Specifies to list only active violations.
Boolean	includeSuppressedAlerts()	Specifies to include suppressed alerts.
List<SdkField<?>>	sdkFields()
static Class<? extends StartDetectMitigationActionsTaskRequest.Builder>	serializableBuilderClass()
DetectMitigationActionsTaskTarget	target()	Specifies the ML Detect findings to which the mitigation actions are applied.
String	taskId()	The unique identifier of the task.
StartDetectMitigationActionsTaskRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

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.

hasActions

public final boolean hasActions()

For responses, this returns true if the service returned a value for the Actions 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.

actions

public final List<String> actions()

The actions to be performed when a device has unexpected behavior.

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 hasActions() method.

Returns:

The actions to be performed when a device has unexpected behavior.

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.

includeOnlyActiveViolations

public final Boolean includeOnlyActiveViolations()

Specifies to list only active violations.

Returns:

Specifies to list only active violations.

includeSuppressedAlerts

public final Boolean includeSuppressedAlerts()

Specifies to include suppressed alerts.

Returns:

Specifies to include suppressed alerts.

clientRequestToken

public final String clientRequestToken()

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Returns:

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

toBuilder

public StartDetectMitigationActionsTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDetectMitigationActionsTaskRequest.Builder,StartDetectMitigationActionsTaskRequest>

Specified by:

toBuilder in class IotRequest

builder

public static StartDetectMitigationActionsTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartDetectMitigationActionsTaskRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo