Class WorldGenerationJobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorldGenerationJobSummary.Builder,
WorldGenerationJobSummary>
Information about a world generator job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the world generator job.builder()
final Instant
The time, in milliseconds since the epoch, when the world generator job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of worlds that failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends WorldGenerationJobSummary.Builder> final WorldGenerationJobStatus
status()
The status of the world generator job:final String
The status of the world generator job:final Integer
The number of worlds that were generated.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the world generator job.
- Returns:
- The Amazon Resource Name (ARN) of the world generator job.
-
template
The Amazon Resource Name (arn) of the world template.
- Returns:
- The Amazon Resource Name (arn) of the world template.
-
createdAt
The time, in milliseconds since the epoch, when the world generator job was created.
- Returns:
- The time, in milliseconds since the epoch, when the world generator job was created.
-
status
The status of the world generator job:
- Pending
-
The world generator job request is pending.
- Running
-
The world generator job is running.
- Completed
-
The world generator job completed.
- Failed
-
The world generator job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generator job was cancelled.
- Canceling
-
The world generator 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 generator job:
- Pending
-
The world generator job request is pending.
- Running
-
The world generator job is running.
- Completed
-
The world generator job completed.
- Failed
-
The world generator job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generator job was cancelled.
- Canceling
-
The world generator job is being cancelled.
- See Also:
-
statusAsString
The status of the world generator job:
- Pending
-
The world generator job request is pending.
- Running
-
The world generator job is running.
- Completed
-
The world generator job completed.
- Failed
-
The world generator job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generator job was cancelled.
- Canceling
-
The world generator 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 generator job:
- Pending
-
The world generator job request is pending.
- Running
-
The world generator job is running.
- Completed
-
The world generator job completed.
- Failed
-
The world generator job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generator job was cancelled.
- Canceling
-
The world generator job is being cancelled.
- See Also:
-
worldCount
Information about the world count.
- Returns:
- Information about the world count.
-
succeededWorldCount
The number of worlds that were generated.
- Returns:
- The number of worlds that were generated.
-
failedWorldCount
The number of worlds that failed.
- Returns:
- The number of worlds that failed.
-
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<WorldGenerationJobSummary.Builder,
WorldGenerationJobSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-