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

Interface CreateWorldGenerationJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CreateWorldGenerationJobResponse.Builder,CreateWorldGenerationJobResponse>, RoboMakerResponse.Builder, SdkBuilder<CreateWorldGenerationJobResponse.Builder,CreateWorldGenerationJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreateWorldGenerationJobResponse

public static interface CreateWorldGenerationJobResponse.Builder
extends RoboMakerResponse.Builder, SdkPojo, CopyableBuilder<CreateWorldGenerationJobResponse.Builder,CreateWorldGenerationJobResponse>

Method Summary

Modifier and Type	Method	Description
CreateWorldGenerationJobResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the world generator job.
CreateWorldGenerationJobResponse.Builder	clientRequestToken(String clientRequestToken)	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateWorldGenerationJobResponse.Builder	createdAt(Instant createdAt)	The time, in milliseconds since the epoch, when the world generator job was created.
CreateWorldGenerationJobResponse.Builder	failureCode(String failureCode)	The failure code of the world generator job if it failed:
CreateWorldGenerationJobResponse.Builder	failureCode(WorldGenerationJobErrorCode failureCode)	The failure code of the world generator job if it failed:
CreateWorldGenerationJobResponse.Builder	status(String status)	The status of the world generator job.
CreateWorldGenerationJobResponse.Builder	status(WorldGenerationJobStatus status)	The status of the world generator job.
CreateWorldGenerationJobResponse.Builder	tags(Map<String,String> tags)	A map that contains tag keys and tag values that are attached to the world generator job.
CreateWorldGenerationJobResponse.Builder	template(String template)	The Amazon Resource Name (arn) of the world template.
default CreateWorldGenerationJobResponse.Builder	worldCount(Consumer<WorldCount.Builder> worldCount)	Information about the world count.
CreateWorldGenerationJobResponse.Builder	worldCount(WorldCount worldCount)	Information about the world count.
CreateWorldGenerationJobResponse.Builder	worldTags(Map<String,String> worldTags)	A map that contains tag keys and tag values that are attached to the generated worlds.

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

copy

Methods inherited from interface software.amazon.awssdk.services.robomaker.model.RoboMakerResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

arn

CreateWorldGenerationJobResponse.Builder arn(String arn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

CreateWorldGenerationJobResponse.Builder status(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WorldGenerationJobStatus, WorldGenerationJobStatus

status

CreateWorldGenerationJobResponse.Builder status(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WorldGenerationJobStatus, WorldGenerationJobStatus

createdAt

CreateWorldGenerationJobResponse.Builder createdAt(Instant createdAt)

The time, in milliseconds since the epoch, when the world generator job was created.

Parameters:

createdAt - The time, in milliseconds since the epoch, when the world generator job was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureCode

CreateWorldGenerationJobResponse.Builder failureCode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WorldGenerationJobErrorCode, WorldGenerationJobErrorCode

failureCode

CreateWorldGenerationJobResponse.Builder failureCode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WorldGenerationJobErrorCode, WorldGenerationJobErrorCode

clientRequestToken

CreateWorldGenerationJobResponse.Builder clientRequestToken(String clientRequestToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

template

CreateWorldGenerationJobResponse.Builder template(String template)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

worldCount

CreateWorldGenerationJobResponse.Builder worldCount(WorldCount worldCount)

Information about the world count.

Parameters:

worldCount - Information about the world count.

Returns:

Returns a reference to this object so that method calls can be chained together.

worldCount

default CreateWorldGenerationJobResponse.Builder worldCount(Consumer<WorldCount.Builder> worldCount)

Information about the world count.

This is a convenience method that creates an instance of the WorldCount.Builder avoiding the need to create one manually via WorldCount.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to worldCount(WorldCount).

Parameters:

worldCount - a consumer that will call methods on WorldCount.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

worldCount(WorldCount)

tags

CreateWorldGenerationJobResponse.Builder tags(Map<String,String> tags)

A map that contains tag keys and tag values that are attached to the world generator job.

Parameters:

tags - A map that contains tag keys and tag values that are attached to the world generator job.

Returns:

Returns a reference to this object so that method calls can be chained together.

worldTags

CreateWorldGenerationJobResponse.Builder worldTags(Map<String,String> worldTags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.