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("software.amazon.awssdk:codegen") public final class DescribeAuditTaskResponse extends IotResponse implements ToCopyableBuilder<DescribeAuditTaskResponse.Builder,DescribeAuditTaskResponse>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

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