Class DescribeWorldGenerationJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeWorldGenerationJobResponse.Builder,
DescribeWorldGenerationJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the world generation job.builder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final Instant
The time, in milliseconds since the epoch, when the world generation job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The failure code of the world generation job if it failed:final String
The failure code of the world generation job if it failed:final String
The reason why the world generation job failed.final FinishedWorldsSummary
Summary information about finished worlds.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the WorldTags property.static Class
<? extends DescribeWorldGenerationJobResponse.Builder> final WorldGenerationJobStatus
status()
The status of the world generation job:final String
The status of the world generation job:tags()
A map that contains tag keys and tag values that are attached to the world generation job.final String
template()
The Amazon Resource Name (arn) of the world template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final WorldCount
Information about the world count.A map that contains tag keys and tag values that are attached to the generated worlds.Methods inherited from class software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the world generation job.
- Returns:
- The Amazon Resource Name (ARN) of the world generation job.
-
status
The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
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 returnWorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
- See Also:
-
statusAsString
The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
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 returnWorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
- See Also:
-
createdAt
The time, in milliseconds since the epoch, when the world generation job was created.
- Returns:
- The time, in milliseconds since the epoch, when the world generation job was created.
-
failureCode
The failure code of the world generation 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 returnWorldGenerationJobErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureCodeAsString()
.- Returns:
- The failure code of the world generation 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
The failure code of the world generation 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 returnWorldGenerationJobErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureCodeAsString()
.- Returns:
- The failure code of the world generation 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
The reason why the world generation job failed.
- Returns:
- The reason why the world generation job failed.
-
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.
-
template
The Amazon Resource Name (arn) of the world template.
- Returns:
- The Amazon Resource Name (arn) of the world template.
-
worldCount
Information about the world count.
- Returns:
- Information about the world count.
-
finishedWorldsSummary
Summary information about finished worlds.
- Returns:
- Summary information about finished worlds.
-
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 theisEmpty()
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
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.- Returns:
- A map that contains tag keys and tag values that are attached to the world generation job.
-
hasWorldTags
public final boolean hasWorldTags()For responses, this returns true if the service returned a value for the WorldTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- A map that contains tag keys and tag values that are attached to the generated worlds.
-
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 interfaceToCopyableBuilder<DescribeWorldGenerationJobResponse.Builder,
DescribeWorldGenerationJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeWorldGenerationJobResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-