Package software.amazon.awssdk.services.iot.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeThingRegistrationTaskResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeThingRegistrationTaskResponse.Builder	builder()
Instant	creationDate()	The task creation date.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	failureCount()	The number of things that failed to be provisioned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	inputFileBucket()	The S3 bucket that contains the input file.
String	inputFileKey()	The input file key.
Instant	lastModifiedDate()	The date when the task was last modified.
String	message()	The message.
Integer	percentageProgress()	The progress of the bulk provisioning task expressed as a percentage.
String	roleArn()	The role ARN that grants access to the input file bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeThingRegistrationTaskResponse.Builder>	serializableBuilderClass()
Status	status()	The status of the bulk thing provisioning task.
String	statusAsString()	The status of the bulk thing provisioning task.
Integer	successCount()	The number of things successfully provisioned.
String	taskId()	The task ID.
String	templateBody()	The task's template.
DescribeThingRegistrationTaskResponse.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

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:

Status

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:

Status

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeThingRegistrationTaskResponse.Builder,DescribeThingRegistrationTaskResponse>

Specified by:

toBuilder in class AwsResponse

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)

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