com.amazonaws.services.iot.model

Class StartDetectMitigationActionsTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.StartDetectMitigationActionsTaskRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartDetectMitigationActionsTaskRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Starts a Device Defender ML Detect mitigation actions task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartDetectMitigationActionsTaskRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getActions() The actions to be performed when a device has unexpected behavior.
java.lang.String	getClientRequestToken() Each mitigation action task must have a unique client request token.
java.lang.Boolean	getIncludeOnlyActiveViolations() Specifies to list only active violations.
java.lang.Boolean	getIncludeSuppressedAlerts() Specifies to include suppressed alerts.
DetectMitigationActionsTaskTarget	getTarget() Specifies the ML Detect findings to which the mitigation actions are applied.
java.lang.String	getTaskId() The unique identifier of the task.
ViolationEventOccurrenceRange	getViolationEventOccurrenceRange() Specifies the time period of which violation events occurred between.
int	hashCode()
java.lang.Boolean	isIncludeOnlyActiveViolations() Specifies to list only active violations.
java.lang.Boolean	isIncludeSuppressedAlerts() Specifies to include suppressed alerts.
void	setActions(java.util.Collection<java.lang.String> actions) The actions to be performed when a device has unexpected behavior.
void	setClientRequestToken(java.lang.String clientRequestToken) Each mitigation action task must have a unique client request token.
void	setIncludeOnlyActiveViolations(java.lang.Boolean includeOnlyActiveViolations) Specifies to list only active violations.
void	setIncludeSuppressedAlerts(java.lang.Boolean includeSuppressedAlerts) Specifies to include suppressed alerts.
void	setTarget(DetectMitigationActionsTaskTarget target) Specifies the ML Detect findings to which the mitigation actions are applied.
void	setTaskId(java.lang.String taskId) The unique identifier of the task.
void	setViolationEventOccurrenceRange(ViolationEventOccurrenceRange violationEventOccurrenceRange) Specifies the time period of which violation events occurred between.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartDetectMitigationActionsTaskRequest	withActions(java.util.Collection<java.lang.String> actions) The actions to be performed when a device has unexpected behavior.
StartDetectMitigationActionsTaskRequest	withActions(java.lang.String... actions) The actions to be performed when a device has unexpected behavior.
StartDetectMitigationActionsTaskRequest	withClientRequestToken(java.lang.String clientRequestToken) Each mitigation action task must have a unique client request token.
StartDetectMitigationActionsTaskRequest	withIncludeOnlyActiveViolations(java.lang.Boolean includeOnlyActiveViolations) Specifies to list only active violations.
StartDetectMitigationActionsTaskRequest	withIncludeSuppressedAlerts(java.lang.Boolean includeSuppressedAlerts) Specifies to include suppressed alerts.
StartDetectMitigationActionsTaskRequest	withTarget(DetectMitigationActionsTaskTarget target) Specifies the ML Detect findings to which the mitigation actions are applied.
StartDetectMitigationActionsTaskRequest	withTaskId(java.lang.String taskId) The unique identifier of the task.
StartDetectMitigationActionsTaskRequest	withViolationEventOccurrenceRange(ViolationEventOccurrenceRange violationEventOccurrenceRange) Specifies the time period of which violation events occurred between.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartDetectMitigationActionsTaskRequest

public StartDetectMitigationActionsTaskRequest()

Method Detail

getTaskId

public java.lang.String getTaskId()

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Returns:

The unique identifier of the task.

setTaskId

public void setTaskId(java.lang.String taskId)

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Parameters:

taskId -

The unique identifier of the task.

withTaskId

public StartDetectMitigationActionsTaskRequest withTaskId(java.lang.String taskId)

The unique identifier of the task.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Parameters:

taskId -

The unique identifier of the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getTarget

public DetectMitigationActionsTaskTarget getTarget()

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.

setTarget

public void setTarget(DetectMitigationActionsTaskTarget target)

Specifies the ML Detect findings to which the mitigation actions are applied.

Parameters:

target -

Specifies the ML Detect findings to which the mitigation actions are applied.

withTarget

public StartDetectMitigationActionsTaskRequest withTarget(DetectMitigationActionsTaskTarget target)

Specifies the ML Detect findings to which the mitigation actions are applied.

Returns a reference to this object so that method calls can be chained together.

Parameters:

target -

Specifies the ML Detect findings to which the mitigation actions are applied.

Returns:

A reference to this updated object so that method calls can be chained together.

getActions

public java.util.List<java.lang.String> getActions()

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

Returns:

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

setActions

public void setActions(java.util.Collection<java.lang.String> actions)

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

Parameters:

actions -

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

withActions

public StartDetectMitigationActionsTaskRequest withActions(java.lang.String... actions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

actions -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withActions

public StartDetectMitigationActionsTaskRequest withActions(java.util.Collection<java.lang.String> actions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

actions -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getViolationEventOccurrenceRange

public ViolationEventOccurrenceRange getViolationEventOccurrenceRange()

Specifies the time period of which violation events occurred between.

Returns:

Specifies the time period of which violation events occurred between.

setViolationEventOccurrenceRange

public void setViolationEventOccurrenceRange(ViolationEventOccurrenceRange violationEventOccurrenceRange)

Specifies the time period of which violation events occurred between.

Parameters:

violationEventOccurrenceRange -

Specifies the time period of which violation events occurred between.

withViolationEventOccurrenceRange

public StartDetectMitigationActionsTaskRequest withViolationEventOccurrenceRange(ViolationEventOccurrenceRange violationEventOccurrenceRange)

Specifies the time period of which violation events occurred between.

Returns a reference to this object so that method calls can be chained together.

Parameters:

violationEventOccurrenceRange -

Specifies the time period of which violation events occurred between.

Returns:

A reference to this updated object so that method calls can be chained together.

isIncludeOnlyActiveViolations

public java.lang.Boolean isIncludeOnlyActiveViolations()

Specifies to list only active violations.

Returns:

Specifies to list only active violations.

getIncludeOnlyActiveViolations

public java.lang.Boolean getIncludeOnlyActiveViolations()

Specifies to list only active violations.

Returns:

Specifies to list only active violations.

setIncludeOnlyActiveViolations

public void setIncludeOnlyActiveViolations(java.lang.Boolean includeOnlyActiveViolations)

Specifies to list only active violations.

Parameters:

includeOnlyActiveViolations -

Specifies to list only active violations.

withIncludeOnlyActiveViolations

public StartDetectMitigationActionsTaskRequest withIncludeOnlyActiveViolations(java.lang.Boolean includeOnlyActiveViolations)

Specifies to list only active violations.

Returns a reference to this object so that method calls can be chained together.

Parameters:

includeOnlyActiveViolations -

Specifies to list only active violations.

Returns:

A reference to this updated object so that method calls can be chained together.

isIncludeSuppressedAlerts

public java.lang.Boolean isIncludeSuppressedAlerts()

Specifies to include suppressed alerts.

Returns:

Specifies to include suppressed alerts.

getIncludeSuppressedAlerts

public java.lang.Boolean getIncludeSuppressedAlerts()

Specifies to include suppressed alerts.

Returns:

Specifies to include suppressed alerts.

setIncludeSuppressedAlerts

public void setIncludeSuppressedAlerts(java.lang.Boolean includeSuppressedAlerts)

Specifies to include suppressed alerts.

Parameters:

includeSuppressedAlerts -

Specifies to include suppressed alerts.

withIncludeSuppressedAlerts

public StartDetectMitigationActionsTaskRequest withIncludeSuppressedAlerts(java.lang.Boolean includeSuppressedAlerts)

Specifies to include suppressed alerts.

Returns a reference to this object so that method calls can be chained together.

Parameters:

includeSuppressedAlerts -

Specifies to include suppressed alerts.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientRequestToken

public java.lang.String getClientRequestToken()

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, AWS SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

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, AWS SDKs will automatically generate a unique client request.

setClientRequestToken

public void setClientRequestToken(java.lang.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, AWS SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

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, AWS SDKs will automatically generate a unique client request.

withClientRequestToken

public StartDetectMitigationActionsTaskRequest withClientRequestToken(java.lang.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, AWS SDKs will automatically generate a unique client request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

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, AWS SDKs will automatically generate a unique client request.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object