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

Class WorldGenerationJobSummary

java.lang.Object

software.amazon.awssdk.services.robomaker.model.WorldGenerationJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorldGenerationJobSummary.Builder,WorldGenerationJobSummary>

@Generated("software.amazon.awssdk:codegen")
public final class WorldGenerationJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorldGenerationJobSummary.Builder,WorldGenerationJobSummary>

Information about a world generator job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorldGenerationJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the world generator job.
static WorldGenerationJobSummary.Builder	builder()
Instant	createdAt()	The time, in milliseconds since the epoch, when the world generator job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	failedWorldCount()	The number of worlds that failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends WorldGenerationJobSummary.Builder>	serializableBuilderClass()
WorldGenerationJobStatus	status()	The status of the world generator job:
String	statusAsString()	The status of the world generator job:
Integer	succeededWorldCount()	The number of worlds that were generated.
String	template()	The Amazon Resource Name (arn) of the world template.
WorldGenerationJobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
WorldCount	worldCount()	Information about the world count.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

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

Returns:

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

template

public final String template()

The Amazon Resource Name (arn) of the world template.

Returns:

The Amazon Resource Name (arn) of the world template.

createdAt

public final Instant 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

public final WorldGenerationJobStatus 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 return WorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

WorldGenerationJobStatus

statusAsString

public final String 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 return WorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

WorldGenerationJobStatus

worldCount

public final WorldCount worldCount()

Information about the world count.

Returns:

Information about the world count.

succeededWorldCount

public final Integer succeededWorldCount()

The number of worlds that were generated.

Returns:

The number of worlds that were generated.

failedWorldCount

public final Integer failedWorldCount()

The number of worlds that failed.

Returns:

The number of worlds that failed.

toBuilder

public WorldGenerationJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorldGenerationJobSummary.Builder,WorldGenerationJobSummary>

builder

public static WorldGenerationJobSummary.Builder builder()

serializableBuilderClass

public static Class<? extends WorldGenerationJobSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo