@Generated(value="software.amazon.awssdk:codegen") public final class DescribeWorldExportJobResponse extends RoboMakerResponse implements ToCopyableBuilder<DescribeWorldExportJobResponse.Builder,DescribeWorldExportJobResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeWorldExportJobResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The Amazon Resource Name (ARN) of the world export job.
|
static DescribeWorldExportJobResponse.Builder |
builder() |
String |
clientRequestToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
Instant |
createdAt()
The time, in milliseconds since the epoch, when the world export job was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
WorldExportJobErrorCode |
failureCode()
The failure code of the world export job if it failed:
|
String |
failureCodeAsString()
The failure code of the world export job if it failed:
|
String |
failureReason()
The reason why the world export job failed.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasWorlds()
For responses, this returns true if the service returned a value for the Worlds property.
|
String |
iamRole()
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
|
OutputLocation |
outputLocation()
Returns the value of the OutputLocation property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeWorldExportJobResponse.Builder> |
serializableBuilderClass() |
WorldExportJobStatus |
status()
The status of the world export job.
|
String |
statusAsString()
The status of the world export job.
|
Map<String,String> |
tags()
A map that contains tag keys and tag values that are attached to the world export job.
|
DescribeWorldExportJobResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
worlds()
A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String arn()
The Amazon Resource Name (ARN) of the world export job.
public final WorldExportJobStatus status()
The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode and failureReason for more information.
The world export job was cancelled.
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().
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode and failureReason for more
information.
The world export job was cancelled.
The world export job is being cancelled.
WorldExportJobStatuspublic final String statusAsString()
The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode and failureReason for more information.
The world export job was cancelled.
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().
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode and failureReason for more
information.
The world export job was cancelled.
The world export job is being cancelled.
WorldExportJobStatuspublic final Instant createdAt()
The time, in milliseconds since the epoch, when the world export job was created.
public final WorldExportJobErrorCode failureCode()
The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
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().
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
WorldExportJobErrorCodepublic final String failureCodeAsString()
The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
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().
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
WorldExportJobErrorCodepublic final String failureReason()
The reason why the world export job failed.
public final String clientRequestToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
public final boolean hasWorlds()
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.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.
public final OutputLocation outputLocation()
public final String iamRole()
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
public final boolean hasTags()
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.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.
public DescribeWorldExportJobResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeWorldExportJobResponse.Builder,DescribeWorldExportJobResponse>toBuilder in class AwsResponsepublic static DescribeWorldExportJobResponse.Builder builder()
public static Class<? extends DescribeWorldExportJobResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2022. All rights reserved.