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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuditDetails() For responses, this returns true if the service returned a value for the AuditDetails property.
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()
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 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 final 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 final 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 final 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 final Instant taskStartTime()

The time the audit started.

Returns:

The time the audit started.

taskStatistics

public final TaskStatistics taskStatistics()

Statistical information about the audit.

Returns:

Statistical information about the audit.

scheduledAuditName

public final 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 final boolean hasAuditDetails()

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

auditDetails

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

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

Returns:

Detailed information about each check performed during this audit.

toBuilder

public DescribeAuditTaskResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAuditTaskResponse.Builder,DescribeAuditTaskResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeAuditTaskResponse.Builder builder()

serializableBuilderClass

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