@Generated(value="software.amazon.awssdk:codegen") public final class DescribeAuditTaskResponse extends IotResponse implements ToCopyableBuilder<DescribeAuditTaskResponse.Builder,DescribeAuditTaskResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeAuditTaskResponse.Builder |
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.
|
responseMetadata
sdkHttpResponse
copy
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()
.
AuditTaskStatus
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()
.
AuditTaskStatus
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()
.
AuditTaskType
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()
.
AuditTaskType
public final Instant taskStartTime()
The time the audit started.
public final TaskStatistics taskStatistics()
Statistical information about the audit.
public final String scheduledAuditName()
The name of the scheduled audit (only if the audit was a scheduled audit).
public final boolean hasAuditDetails()
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.
You can use hasAuditDetails()
to see if a value was sent in this field.
public DescribeAuditTaskResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeAuditTaskResponse.Builder,DescribeAuditTaskResponse>
toBuilder
in class AwsResponse
public static DescribeAuditTaskResponse.Builder builder()
public static Class<? extends DescribeAuditTaskResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.