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

Interface DescribeWorldGenerationJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>, RoboMakerResponse.Builder, SdkBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeWorldGenerationJobResponse
public static interface DescribeWorldGenerationJobResponse.Builder extends RoboMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>

  • Method Details

    • arn

      DescribeWorldGenerationJobResponse.Builder arn(String arn)

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

      Parameters:
      arn - The Amazon Resource Name (ARN) of the world generation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

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

      Parameters:
      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.

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

    • status

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

      Parameters:
      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.

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

    • createdAt

      DescribeWorldGenerationJobResponse.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - The time, in milliseconds since the epoch, when the world generation job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureCode

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

      Parameters:
      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.

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

    • failureCode

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

      Parameters:
      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.

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

    • failureReason

      DescribeWorldGenerationJobResponse.Builder failureReason(String failureReason)

      The reason why the world generation job failed.

      Parameters:
      failureReason - The reason why the world generation job failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

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

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

      DescribeWorldGenerationJobResponse.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 DescribeWorldGenerationJobResponse.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:

    • finishedWorldsSummary

      DescribeWorldGenerationJobResponse.Builder finishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)

      Summary information about finished worlds.

      Parameters:
      finishedWorldsSummary - Summary information about finished worlds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • finishedWorldsSummary

      default DescribeWorldGenerationJobResponse.Builder finishedWorldsSummary(Consumer<FinishedWorldsSummary.Builder> finishedWorldsSummary)

      Summary information about finished worlds.

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

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

      Parameters:
      finishedWorldsSummary - a consumer that will call methods on FinishedWorldsSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

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

      Parameters:
      tags - A map that contains tag keys and tag values that are attached to the world generation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • worldTags

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