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

Class DescribeAuditMitigationActionsTaskResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.DescribeAuditMitigationActionsTaskResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAuditMitigationActionsTaskResponse.Builder,DescribeAuditMitigationActionsTaskResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAuditMitigationActionsTaskResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<MitigationAction>	actionsDefinition()	Specifies the mitigation actions and their parameters that are applied as part of this task.
Map<String,List<String>>	auditCheckToActionsMapping()	Specifies the mitigation actions that should be applied to specific audit checks.
static DescribeAuditMitigationActionsTaskResponse.Builder	builder()
Instant	endTime()	The date and time when the task was completed or canceled.
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.
boolean	hasAuditCheckToActionsMapping()	For responses, this returns true if the service returned a value for the AuditCheckToActionsMapping property.
int	hashCode()
boolean	hasTaskStatistics()	For responses, this returns true if the service returned a value for the TaskStatistics property.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAuditMitigationActionsTaskResponse.Builder>	serializableBuilderClass()
Instant	startTime()	The date and time when the task was started.
AuditMitigationActionsTaskTarget	target()	Identifies the findings to which the mitigation actions are applied.
Map<String,TaskStatisticsForAuditCheck>	taskStatistics()	Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
AuditMitigationActionsTaskStatus	taskStatus()	The current status of the task.
String	taskStatusAsString()	The current status of the task.
DescribeAuditMitigationActionsTaskResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

taskStatus

public final AuditMitigationActionsTaskStatus taskStatus()

The current status of the task.

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

Returns:

The current status of the task.

See Also:

AuditMitigationActionsTaskStatus

taskStatusAsString

public final String taskStatusAsString()

The current status of the task.

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

Returns:

The current status of the task.

See Also:

AuditMitigationActionsTaskStatus

startTime

public final Instant startTime()

The date and time when the task was started.

Returns:

The date and time when the task was started.

endTime

public final Instant endTime()

The date and time when the task was completed or canceled.

Returns:

The date and time when the task was completed or canceled.

hasTaskStatistics

public final boolean hasTaskStatistics()

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

taskStatistics

public final Map<String,TaskStatisticsForAuditCheck> taskStatistics()

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

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

Returns:

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

target

public final AuditMitigationActionsTaskTarget target()

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

Returns:

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a 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()

Specifies the mitigation actions that should be applied to specific audit checks.

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:

Specifies the mitigation actions that should be applied to specific audit checks.

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

Specifies the mitigation actions and their parameters that are applied as part of this task.

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:

Specifies the mitigation actions and their parameters that are applied as part of this task.

toBuilder

public DescribeAuditMitigationActionsTaskResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAuditMitigationActionsTaskResponse.Builder,DescribeAuditMitigationActionsTaskResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeAuditMitigationActionsTaskResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo