Interface StartSimulationJobBatchResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<StartSimulationJobBatchResponse.Builder,
,StartSimulationJobBatchResponse> RoboMakerResponse.Builder
,SdkBuilder<StartSimulationJobBatchResponse.Builder,
,StartSimulationJobBatchResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
StartSimulationJobBatchResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (arn) of the batch.batchPolicy
(Consumer<BatchPolicy.Builder> batchPolicy) The batch policy.batchPolicy
(BatchPolicy batchPolicy) The batch policy.clientRequestToken
(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.The time, in milliseconds since the epoch, when the simulation job batch was created.createdRequests
(Collection<SimulationJobSummary> createdRequests) A list of created simulation job request summaries.createdRequests
(Consumer<SimulationJobSummary.Builder>... createdRequests) A list of created simulation job request summaries.createdRequests
(SimulationJobSummary... createdRequests) A list of created simulation job request summaries.failedRequests
(Collection<FailedCreateSimulationJobRequest> failedRequests) A list of failed simulation job requests.failedRequests
(Consumer<FailedCreateSimulationJobRequest.Builder>... failedRequests) A list of failed simulation job requests.failedRequests
(FailedCreateSimulationJobRequest... failedRequests) A list of failed simulation job requests.failureCode
(String failureCode) The failure code if the simulation job batch failed.failureCode
(SimulationJobBatchErrorCode failureCode) The failure code if the simulation job batch failed.failureReason
(String failureReason) The reason the simulation job batch failed.pendingRequests
(Collection<SimulationJobRequest> pendingRequests) A list of pending simulation job requests.pendingRequests
(Consumer<SimulationJobRequest.Builder>... pendingRequests) A list of pending simulation job requests.pendingRequests
(SimulationJobRequest... pendingRequests) A list of pending simulation job requests.The status of the simulation job batch.status
(SimulationJobBatchStatus status) The status of the simulation job batch.A map that contains tag keys and tag values that are attached to the deployment job batch.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 Details
-
arn
The Amazon Resource Name (arn) of the batch.
- Parameters:
arn
- The Amazon Resource Name (arn) of the batch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the simulation job batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
- Parameters:
status
- The status of the simulation job batch.- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the simulation job batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
- Parameters:
status
- The status of the simulation job batch.- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdAt
The time, in milliseconds since the epoch, when the simulation job batch was created.
- Parameters:
createdAt
- The time, in milliseconds since the epoch, when the simulation job batch was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
batchPolicy
The batch policy.
- Parameters:
batchPolicy
- The batch policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
batchPolicy
default StartSimulationJobBatchResponse.Builder batchPolicy(Consumer<BatchPolicy.Builder> batchPolicy) The batch policy.
This is a convenience method that creates an instance of theBatchPolicy.Builder
avoiding the need to create one manually viaBatchPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobatchPolicy(BatchPolicy)
.- Parameters:
batchPolicy
- a consumer that will call methods onBatchPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureCode
The failure code if the simulation job batch failed.
- Parameters:
failureCode
- The failure code if the simulation job batch failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureCode
The failure code if the simulation job batch failed.
- Parameters:
failureCode
- The failure code if the simulation job batch failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureReason
The reason the simulation job batch failed.
- Parameters:
failureReason
- The reason the simulation job batch failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failedRequests
StartSimulationJobBatchResponse.Builder failedRequests(Collection<FailedCreateSimulationJobRequest> failedRequests) A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
- Parameters:
failedRequests
- A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failedRequests
StartSimulationJobBatchResponse.Builder failedRequests(FailedCreateSimulationJobRequest... failedRequests) A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
- Parameters:
failedRequests
- A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failedRequests
StartSimulationJobBatchResponse.Builder failedRequests(Consumer<FailedCreateSimulationJobRequest.Builder>... failedRequests) A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
This is a convenience method that creates an instance of theFailedCreateSimulationJobRequest.Builder
avoiding the need to create one manually viaFailedCreateSimulationJobRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofailedRequests(List<FailedCreateSimulationJobRequest>)
.- Parameters:
failedRequests
- a consumer that will call methods onFailedCreateSimulationJobRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
pendingRequests
StartSimulationJobBatchResponse.Builder pendingRequests(Collection<SimulationJobRequest> pendingRequests) A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
- Parameters:
pendingRequests
- A list of pending simulation job requests. These requests have not yet been created into simulation jobs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingRequests
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
- Parameters:
pendingRequests
- A list of pending simulation job requests. These requests have not yet been created into simulation jobs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingRequests
StartSimulationJobBatchResponse.Builder pendingRequests(Consumer<SimulationJobRequest.Builder>... pendingRequests) A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
This is a convenience method that creates an instance of theSimulationJobRequest.Builder
avoiding the need to create one manually viaSimulationJobRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topendingRequests(List<SimulationJobRequest>)
.- Parameters:
pendingRequests
- a consumer that will call methods onSimulationJobRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdRequests
StartSimulationJobBatchResponse.Builder createdRequests(Collection<SimulationJobSummary> createdRequests) A list of created simulation job request summaries.
- Parameters:
createdRequests
- A list of created simulation job request summaries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdRequests
A list of created simulation job request summaries.
- Parameters:
createdRequests
- A list of created simulation job request summaries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdRequests
StartSimulationJobBatchResponse.Builder createdRequests(Consumer<SimulationJobSummary.Builder>... createdRequests) A list of created simulation job request summaries.
This is a convenience method that creates an instance of theSimulationJobSummary.Builder
avoiding the need to create one manually viaSimulationJobSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreatedRequests(List<SimulationJobSummary>)
.- Parameters:
createdRequests
- a consumer that will call methods onSimulationJobSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
A map that contains tag keys and tag values that are attached to the deployment job batch.
- Parameters:
tags
- A map that contains tag keys and tag values that are attached to the deployment job batch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-