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>

  • Method Details

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

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

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

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