@Generated(value="software.amazon.awssdk:codegen") public final class DescribeWorldGenerationJobResponse extends RoboMakerResponse implements ToCopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeWorldGenerationJobResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The Amazon Resource Name (ARN) of the world generation job.
|
static DescribeWorldGenerationJobResponse.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 generation job was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
WorldGenerationJobErrorCode |
failureCode()
The failure code of the world generation job if it failed:
|
String |
failureCodeAsString()
The failure code of the world generation job if it failed:
|
String |
failureReason()
The reason why the world generation job failed.
|
FinishedWorldsSummary |
finishedWorldsSummary()
Summary information about finished worlds.
|
<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 |
hasWorldTags()
For responses, this returns true if the service returned a value for the WorldTags property.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeWorldGenerationJobResponse.Builder> |
serializableBuilderClass() |
WorldGenerationJobStatus |
status()
The status of the world generation job:
|
String |
statusAsString()
The status of the world generation job:
|
Map<String,String> |
tags()
A map that contains tag keys and tag values that are attached to the world generation job.
|
String |
template()
The Amazon Resource Name (arn) of the world template.
|
DescribeWorldGenerationJobResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
WorldCount |
worldCount()
Information about the world count.
|
Map<String,String> |
worldTags()
A map that contains tag keys and tag values that are attached to the generated worlds.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String arn()
The Amazon Resource Name (ARN) of the world generation job.
public final WorldGenerationJobStatus status()
The status of the world generation job:
The world generation job request is pending.
The world generation job is running.
The world generation job completed.
The world generation job failed. See failureCode for more information.
Some worlds did not generate.
The world generation job was cancelled.
The world generation job is being cancelled.
If the service returns an enum value that is not available in the current SDK version, status will
return WorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from statusAsString().
The world generation job request is pending.
The world generation job is running.
The world generation job completed.
The world generation job failed. See failureCode for more information.
Some worlds did not generate.
The world generation job was cancelled.
The world generation job is being cancelled.
WorldGenerationJobStatuspublic final String statusAsString()
The status of the world generation job:
The world generation job request is pending.
The world generation job is running.
The world generation job completed.
The world generation job failed. See failureCode for more information.
Some worlds did not generate.
The world generation job was cancelled.
The world generation job is being cancelled.
If the service returns an enum value that is not available in the current SDK version, status will
return WorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from statusAsString().
The world generation job request is pending.
The world generation job is running.
The world generation job completed.
The world generation job failed. See failureCode for more information.
Some worlds did not generate.
The world generation job was cancelled.
The world generation job is being cancelled.
WorldGenerationJobStatuspublic final Instant createdAt()
The time, in milliseconds since the epoch, when the world generation job was created.
public final WorldGenerationJobErrorCode failureCode()
The failure code of the world generation 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 WorldGenerationJobErrorCode.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.
WorldGenerationJobErrorCodepublic final String failureCodeAsString()
The failure code of the world generation 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 WorldGenerationJobErrorCode.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.
WorldGenerationJobErrorCodepublic final String failureReason()
The reason why the world generation job failed.
public final String clientRequestToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
public final String template()
The Amazon Resource Name (arn) of the world template.
public final WorldCount worldCount()
Information about the world count.
public final FinishedWorldsSummary finishedWorldsSummary()
Summary information about finished worlds.
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 generation 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 final boolean hasWorldTags()
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> worldTags()
A map that contains tag keys and tag values that are attached to the generated worlds.
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 hasWorldTags() method.
public DescribeWorldGenerationJobResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>toBuilder in class AwsResponsepublic static DescribeWorldGenerationJobResponse.Builder builder()
public static Class<? extends DescribeWorldGenerationJobResponse.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.