AuditMitigationActionExecutionMetadata (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.iot.model.AuditMitigationActionExecutionMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuditMitigationActionExecutionMetadata.Builder,AuditMitigationActionExecutionMetadata>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AuditMitigationActionExecutionMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AuditMitigationActionExecutionMetadata.Builder,AuditMitigationActionExecutionMetadata>
```
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AuditMitigationActionExecutionMetadata.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AuditMitigationActionExecutionMetadata.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`actionId()` The unique identifier for the mitigation action being applied by the task.
`String`	`actionName()` The friendly name of the mitigation action being applied by the task.
`static AuditMitigationActionExecutionMetadata.Builder`	`builder()`
`Instant`	`endTime()` The date and time when the task was completed or canceled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`String`	`errorCode()` If an error occurred, the code that indicates which type of error occurred.
`String`	`findingId()` The unique identifier for the findings to which the task and associated mitigation action are applied.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`message()` If an error occurred, a message that describes the error.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AuditMitigationActionExecutionMetadata.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The date and time when the task was started.
`AuditMitigationActionsExecutionStatus`	`status()` The current status of the task being executed.
`String`	`statusAsString()` The current status of the task being executed.
`String`	`taskId()` The unique identifier for the task that applies the mitigation action.
`AuditMitigationActionExecutionMetadata.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
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 for the task that applies the mitigation action.
    
    Returns:
    
    The unique identifier for the task that applies the mitigation action.
  - findingId
```
public final String findingId()
```
    The unique identifier for the findings to which the task and associated mitigation action are applied.
    
    Returns:
    
    The unique identifier for the findings to which the task and associated mitigation action are applied.
  - actionName
```
public final String actionName()
```
    The friendly name of the mitigation action being applied by the task.
    
    Returns:
    
    The friendly name of the mitigation action being applied by the task.
  - actionId
```
public final String actionId()
```
    The unique identifier for the mitigation action being applied by the task.
    
    Returns:
    
    The unique identifier for the mitigation action being applied by the task.
  - status
```
public final AuditMitigationActionsExecutionStatus status()
```
    The current status of the task being executed.
    
    If the service returns an enum value that is not available in the current SDK version, status will return AuditMitigationActionsExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the task being executed.
    
    See Also:
    
    AuditMitigationActionsExecutionStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the task being executed.
    
    If the service returns an enum value that is not available in the current SDK version, status will return AuditMitigationActionsExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the task being executed.
    
    See Also:
    
    AuditMitigationActionsExecutionStatus
  - 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. Blank if the task is still running.
    
    Returns:
    
    The date and time when the task was completed or canceled. Blank if the task is still running.
  - errorCode
```
public final String errorCode()
```
    If an error occurred, the code that indicates which type of error occurred.
    
    Returns:
    
    If an error occurred, the code that indicates which type of error occurred.
  - message
```
public final String message()
```
    If an error occurred, a message that describes the error.
    
    Returns:
    
    If an error occurred, a message that describes the error.
  - toBuilder
```
public AuditMitigationActionExecutionMetadata.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AuditMitigationActionExecutionMetadata.Builder,AuditMitigationActionExecutionMetadata>
    
    Returns:
    
    a builder for type T
  - builder
```
public static AuditMitigationActionExecutionMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AuditMitigationActionExecutionMetadata.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.43

Class AuditMitigationActionExecutionMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

taskId

findingId

actionName

actionId

status

statusAsString

startTime

endTime

errorCode

message

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields