Package software.amazon.awssdk.services.robomaker.model

Class DescribeWorldExportJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
software.amazon.awssdk.services.robomaker.model.DescribeWorldExportJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeWorldExportJobResponse.Builder,DescribeWorldExportJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeWorldExportJobResponse extends RoboMakerResponse implements ToCopyableBuilder<DescribeWorldExportJobResponse.Builder,DescribeWorldExportJobResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the world export job.

      Returns:
      The Amazon Resource Name (ARN) of the world export job.

    • status

      public final WorldExportJobStatus status()

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

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

      Returns:
      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

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

      Returns:
      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      See Also:

    • createdAt

      public final Instant createdAt()

      The time, in milliseconds since the epoch, when the world export job was created.

      Returns:
      The time, in milliseconds since the epoch, when the world export job was created.

    • failureCode

      public final WorldExportJobErrorCode failureCode()

      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

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

      Returns:
      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

      See Also:

    • failureCodeAsString

      public final String failureCodeAsString()

      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

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

      Returns:
      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

      See Also:

    • failureReason

      public final String failureReason()

      The reason why the world export job failed.

      Returns:
      The reason why the world export job failed.

    • clientRequestToken

      public final String clientRequestToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • hasWorlds

      public final boolean hasWorlds()
      For responses, this returns true if the service returned a value for the Worlds 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.

    • worlds

      public final List<String> worlds()

      A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

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

      Returns:
      A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

    • outputLocation

      public final OutputLocation outputLocation()
      Returns the value of the OutputLocation property for this object.
      Returns:
      The value of the OutputLocation property for this object.

    • iamRole

      public final String iamRole()

      The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

      Returns:
      The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      A map that contains tag keys and tag values that are attached to the world export job.

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

      Returns:
      A map that contains tag keys and tag values that are attached to the world export job.

    • toBuilder

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

    • builder

      public static DescribeWorldExportJobResponse.Builder builder()

    • serializableBuilderClass

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