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

Interface DescribeWorldExportJobResponse.Builder

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

  • Method Details

    • arn

      DescribeWorldExportJobResponse.Builder arn(String arn)

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

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

    • status

      DescribeWorldExportJobResponse.Builder status(String status)

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      Parameters:
      status - The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

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

    • status

      DescribeWorldExportJobResponse.Builder status(WorldExportJobStatus status)

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      Parameters:
      status - The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode and failureReason for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

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

    • createdAt

      DescribeWorldExportJobResponse.Builder createdAt(Instant createdAt)

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

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

    • failureCode

      DescribeWorldExportJobResponse.Builder failureCode(String failureCode)

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

      DescribeWorldExportJobResponse.Builder failureCode(WorldExportJobErrorCode failureCode)

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

      DescribeWorldExportJobResponse.Builder failureReason(String failureReason)

      The reason why the world export job failed.

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

    • clientRequestToken

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

    • worlds

      DescribeWorldExportJobResponse.Builder worlds(Collection<String> worlds)

      A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

      Parameters:
      worlds - A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • worlds

      DescribeWorldExportJobResponse.Builder worlds(String... worlds)

      A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

      Parameters:
      worlds - A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      DescribeWorldExportJobResponse.Builder outputLocation(OutputLocation outputLocation)
      Sets the value of the OutputLocation property for this object.
      Parameters:
      outputLocation - The new value for the OutputLocation property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      default DescribeWorldExportJobResponse.Builder outputLocation(Consumer<OutputLocation.Builder> outputLocation)
      Sets the value of the OutputLocation property for this object. This is a convenience method that creates an instance of the OutputLocation.Builder avoiding the need to create one manually via OutputLocation.builder().

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

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

    • iamRole

      DescribeWorldExportJobResponse.Builder iamRole(String iamRole)

      The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

      Parameters:
      iamRole - The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

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

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