software.amazon.awssdk.services.iot.model

Class StartAuditMitigationActionsTaskRequest

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.StartAuditMitigationActionsTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartAuditMitigationActionsTaskRequest.Builder,StartAuditMitigationActionsTaskRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartAuditMitigationActionsTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	auditCheckToActionsMapping() For an audit check, specifies which mitigation actions to apply.
static StartAuditMitigationActionsTaskRequest.Builder	builder()
String	clientRequestToken() Each audit mitigation 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	hasAuditCheckToActionsMapping() For responses, this returns true if the service returned a value for the AuditCheckToActionsMapping property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StartAuditMitigationActionsTaskRequest.Builder>	serializableBuilderClass()
AuditMitigationActionsTaskTarget	target() Specifies the audit findings to which the mitigation actions are applied.
String	taskId() A unique identifier for the task.
StartAuditMitigationActionsTaskRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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()

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

Returns:

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

target

public final AuditMitigationActionsTaskTarget target()

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

Returns:

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

hasAuditCheckToActionsMapping

public final boolean hasAuditCheckToActionsMapping()

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

auditCheckToActionsMapping

public final Map<String,List<String>> auditCheckToActionsMapping()

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

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

Returns:

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

clientRequestToken

public final String clientRequestToken()

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

Returns:

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

toBuilder

public StartAuditMitigationActionsTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartAuditMitigationActionsTaskRequest.Builder,StartAuditMitigationActionsTaskRequest>

Specified by:

toBuilder in class IotRequest

builder

public static StartAuditMitigationActionsTaskRequest.Builder builder()

serializableBuilderClass

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