Interface CreateWorldExportJobResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<CreateWorldExportJobResponse.Builder,CreateWorldExportJobResponse>,RoboMakerResponse.Builder,SdkBuilder<CreateWorldExportJobResponse.Builder,CreateWorldExportJobResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- CreateWorldExportJobResponse
public static interface CreateWorldExportJobResponse.Builder extends RoboMakerResponse.Builder, SdkPojo, CopyableBuilder<CreateWorldExportJobResponse.Builder,CreateWorldExportJobResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateWorldExportJobResponse.Builderarn(String arn)The Amazon Resource Name (ARN) of the world export job.CreateWorldExportJobResponse.BuilderclientRequestToken(String clientRequestToken)Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.CreateWorldExportJobResponse.BuildercreatedAt(Instant createdAt)The time, in milliseconds since the epoch, when the world export job was created.CreateWorldExportJobResponse.BuilderfailureCode(String failureCode)The failure code of the world export job if it failed:CreateWorldExportJobResponse.BuilderfailureCode(WorldExportJobErrorCode failureCode)The failure code of the world export job if it failed:CreateWorldExportJobResponse.BuilderiamRole(String iamRole)The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.default CreateWorldExportJobResponse.BuilderoutputLocation(Consumer<OutputLocation.Builder> outputLocation)Sets the value of the OutputLocation property for this object.CreateWorldExportJobResponse.BuilderoutputLocation(OutputLocation outputLocation)Sets the value of the OutputLocation property for this object.CreateWorldExportJobResponse.Builderstatus(String status)The status of the world export job.CreateWorldExportJobResponse.Builderstatus(WorldExportJobStatus status)The status of the world export job.CreateWorldExportJobResponse.Buildertags(Map<String,String> tags)A map that contains tag keys and tag values that are attached to the world export job.-
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
CreateWorldExportJobResponse.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
CreateWorldExportJobResponse.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
failureCodefor 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
failureCodefor 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:
WorldExportJobStatus,WorldExportJobStatus
-
status
CreateWorldExportJobResponse.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
failureCodefor 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
failureCodefor 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:
WorldExportJobStatus,WorldExportJobStatus
-
createdAt
CreateWorldExportJobResponse.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
CreateWorldExportJobResponse.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.
- AllWorldGenerationFailed
-
All of the worlds in the world generation job failed. This can happen if your
worldCountis greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
- 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.
- AllWorldGenerationFailed
-
All of the worlds in the world generation job failed. This can happen if your
worldCountis greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorldExportJobErrorCode,WorldExportJobErrorCode
-
failureCode
CreateWorldExportJobResponse.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.
- AllWorldGenerationFailed
-
All of the worlds in the world generation job failed. This can happen if your
worldCountis greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
- 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.
- AllWorldGenerationFailed
-
All of the worlds in the world generation job failed. This can happen if your
worldCountis greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorldExportJobErrorCode,WorldExportJobErrorCode
-
clientRequestToken
CreateWorldExportJobResponse.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.
-
outputLocation
CreateWorldExportJobResponse.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 CreateWorldExportJobResponse.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 theOutputLocation.Builderavoiding the need to create one manually viaOutputLocation.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutputLocation(OutputLocation).- Parameters:
outputLocation- a consumer that will call methods onOutputLocation.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
outputLocation(OutputLocation)
-
iamRole
CreateWorldExportJobResponse.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
CreateWorldExportJobResponse.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.
-
-