Class DescribeThingRegistrationTaskResponse

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.DescribeThingRegistrationTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeThingRegistrationTaskResponse.Builder,DescribeThingRegistrationTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeThingRegistrationTaskResponse extends IotResponse implements ToCopyableBuilder<DescribeThingRegistrationTaskResponse.Builder,DescribeThingRegistrationTaskResponse>

  • Method Details

    • taskId

      public final String taskId()

      The task ID.

      Returns:
      The task ID.

    • creationDate

      public final Instant creationDate()

      The task creation date.

      Returns:
      The task creation date.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date when the task was last modified.

      Returns:
      The date when the task was last modified.

    • templateBody

      public final String templateBody()

      The task's template.

      Returns:
      The task's template.

    • inputFileBucket

      public final String inputFileBucket()

      The S3 bucket that contains the input file.

      Returns:
      The S3 bucket that contains the input file.

    • inputFileKey

      public final String inputFileKey()

      The input file key.

      Returns:
      The input file key.

    • roleArn

      public final String roleArn()

      The role ARN that grants access to the input file bucket.

      Returns:
      The role ARN that grants access to the input file bucket.

    • status

      public final Status status()

      The status of the bulk thing provisioning task.

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

      Returns:
      The status of the bulk thing provisioning task.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the bulk thing provisioning task.

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

      Returns:
      The status of the bulk thing provisioning task.
      See Also:

    • message

      public final String message()

      The message.

      Returns:
      The message.

    • successCount

      public final Integer successCount()

      The number of things successfully provisioned.

      Returns:
      The number of things successfully provisioned.

    • failureCount

      public final Integer failureCount()

      The number of things that failed to be provisioned.

      Returns:
      The number of things that failed to be provisioned.

    • percentageProgress

      public final Integer percentageProgress()

      The progress of the bulk provisioning task expressed as a percentage.

      Returns:
      The progress of the bulk provisioning task expressed as a percentage.

    • toBuilder

      public DescribeThingRegistrationTaskResponse.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<DescribeThingRegistrationTaskResponse.Builder,DescribeThingRegistrationTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeThingRegistrationTaskResponse.Builder builder()

    • serializableBuilderClass

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