Package software.amazon.awssdk.services.iotthingsgraph.model

Class GetUploadStatusResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphResponse

software.amazon.awssdk.services.iotthingsgraph.model.GetUploadStatusResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUploadStatusResponse.Builder,GetUploadStatusResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetUploadStatusResponse
extends IoTThingsGraphResponse
implements ToCopyableBuilder<GetUploadStatusResponse.Builder,GetUploadStatusResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetUploadStatusResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetUploadStatusResponse.Builder	builder()
Instant	createdDate()	The date at which the upload was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	failureReason()	The reason for an upload failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailureReason()	For responses, this returns true if the service returned a value for the FailureReason property.
int	hashCode()
String	namespaceArn()	The ARN of the upload.
String	namespaceName()	The name of the upload's namespace.
Long	namespaceVersion()	The version of the user's namespace.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUploadStatusResponse.Builder>	serializableBuilderClass()
GetUploadStatusResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	uploadId()	The ID of the upload.
UploadStatus	uploadStatus()	The status of the upload.
String	uploadStatusAsString()	The status of the upload.

Methods inherited from class software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphResponse

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

uploadId

public final String uploadId()

The ID of the upload.

Returns:

The ID of the upload.

uploadStatus

public final UploadStatus uploadStatus()

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

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

Returns:

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

See Also:

UploadStatus

uploadStatusAsString

public final String uploadStatusAsString()

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

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

Returns:

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

See Also:

UploadStatus

namespaceArn

public final String namespaceArn()

The ARN of the upload.

Returns:

The ARN of the upload.

namespaceName

public final String namespaceName()

The name of the upload's namespace.

Returns:

The name of the upload's namespace.

namespaceVersion

public final Long namespaceVersion()

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Returns:

The version of the user's namespace. Defaults to the latest version of the user's namespace.

hasFailureReason

public final boolean hasFailureReason()

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

failureReason

public final List<String> failureReason()

The reason for an upload failure.

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

Returns:

The reason for an upload failure.

createdDate

public final Instant createdDate()

The date at which the upload was created.

Returns:

The date at which the upload was created.

toBuilder

public GetUploadStatusResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUploadStatusResponse.Builder,GetUploadStatusResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetUploadStatusResponse.Builder builder()

serializableBuilderClass

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