software.amazon.awssdk.services.iot.model

Class DescribeAuditTaskResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAuditTaskResponse.Builder,DescribeAuditTaskResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAuditTaskResponse.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,AuditCheckDetails>	auditDetails() Detailed information about each check performed during this audit.
static DescribeAuditTaskResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasAuditDetails() Returns true if the AuditDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	scheduledAuditName() The name of the scheduled audit (only if the audit was a scheduled audit).
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAuditTaskResponse.Builder>	serializableBuilderClass()
Instant	taskStartTime() The time the audit started.
TaskStatistics	taskStatistics() Statistical information about the audit.
AuditTaskStatus	taskStatus() The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
String	taskStatusAsString() The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
AuditTaskType	taskType() The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
String	taskTypeAsString() The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
DescribeAuditTaskResponse.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 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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

taskStatus

public AuditTaskStatus taskStatus()

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

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

Returns:

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

See Also:

AuditTaskStatus

taskStatusAsString

public String taskStatusAsString()

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

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

Returns:

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

See Also:

AuditTaskStatus

taskType

public AuditTaskType taskType()

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

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

Returns:

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

See Also:

AuditTaskType

taskTypeAsString

public String taskTypeAsString()

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

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

Returns:

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

See Also:

AuditTaskType

taskStartTime

public Instant taskStartTime()

The time the audit started.

Returns:

The time the audit started.

taskStatistics

public TaskStatistics taskStatistics()

Statistical information about the audit.

Returns:

Statistical information about the audit.

scheduledAuditName

public String scheduledAuditName()

The name of the scheduled audit (only if the audit was a scheduled audit).

Returns:

The name of the scheduled audit (only if the audit was a scheduled audit).

hasAuditDetails

public boolean hasAuditDetails()

Returns true if the AuditDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

auditDetails

public Map<String,AuditCheckDetails> auditDetails()

Detailed information about each check performed during this audit.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAuditDetails() to see if a value was sent in this field.

Returns:

Detailed information about each check performed during this audit.

toBuilder

public DescribeAuditTaskResponse.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<DescribeAuditTaskResponse.Builder,DescribeAuditTaskResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeAuditTaskResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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