Class CreateWorldGenerationJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.robomaker.model.RoboMakerResponse

software.amazon.awssdk.services.robomaker.model.CreateWorldGenerationJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorldGenerationJobResponse.Builder,CreateWorldGenerationJobResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CreateWorldGenerationJobResponse
extends RoboMakerResponse
implements ToCopyableBuilder<CreateWorldGenerationJobResponse.Builder,CreateWorldGenerationJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWorldGenerationJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
final String	arn()	The Amazon Resource Name (ARN) of the world generator job.
static CreateWorldGenerationJobResponse.Builder	builder()
final String	clientRequestToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
final Instant	createdAt()	The time, in milliseconds since the epoch, when the world generator job was created.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final WorldGenerationJobErrorCode	failureCode()	The failure code of the world generator job if it failed:
final String	failureCodeAsString()	The failure code of the world generator job if it failed:
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkResponse.
final int	hashCode()
final boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
final boolean	hasWorldTags()	For responses, this returns true if the service returned a value for the WorldTags property.
final List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorldGenerationJobResponse.Builder>	serializableBuilderClass()
final WorldGenerationJobStatus	status()	The status of the world generator job.
final String	statusAsString()	The status of the world generator job.
final Map<String,String>	tags()	A map that contains tag keys and tag values that are attached to the world generator job.
final String	template()	The Amazon Resource Name (arn) of the world template.
CreateWorldGenerationJobResponse.Builder	toBuilder()	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	worldCount()	Information about the world count.
final Map<String,String>	worldTags()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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.

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

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.

failureCode

public final WorldGenerationJobErrorCode failureCode()

The failure code of the world generator 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 return WorldGenerationJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().

Returns:

The failure code of the world generator 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:

• WorldGenerationJobErrorCode

failureCodeAsString

public final String failureCodeAsString()

The failure code of the world generator 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 return WorldGenerationJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().

Returns:

The failure code of the world generator 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:

• WorldGenerationJobErrorCode

clientRequestToken

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

public final String template()

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

Returns:

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

worldCount

public final WorldCount worldCount()

Information about the world count.

Returns:

Information about the world count.

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 the 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.

tags

public final Map<String,String> tags()

A map that contains tag keys and tag values that are attached to the world generator 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 generator 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 the 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.

worldTags

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.

Returns:

A map that contains tag keys and tag values that are attached to the generated worlds.

toBuilder

public CreateWorldGenerationJobResponse.Builder 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 interface ToCopyableBuilder<CreateWorldGenerationJobResponse.Builder,CreateWorldGenerationJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CreateWorldGenerationJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.