Interface StartSimulationJobBatchResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<StartSimulationJobBatchResponse.Builder,StartSimulationJobBatchResponse>, RoboMakerResponse.Builder, SdkBuilder<StartSimulationJobBatchResponse.Builder,StartSimulationJobBatchResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
StartSimulationJobBatchResponse

public static interface StartSimulationJobBatchResponse.Builder extends RoboMakerResponse.Builder, SdkPojo, CopyableBuilder<StartSimulationJobBatchResponse.Builder,StartSimulationJobBatchResponse>
  • 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). See failureCode and failureReason 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 or Failed).

      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 be Failed. If there are no such failing request, the batch status will be TimedOut.

      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). See failureCode and failureReason 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 or Failed).

      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 be Failed. If there are no such failing request, the batch status will be TimedOut.

      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). See failureCode and failureReason 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 or Failed).

      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 be Failed. If there are no such failing request, the batch status will be TimedOut.

      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). See failureCode and failureReason 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 or Failed).

      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 be Failed. If there are no such failing request, the batch status will be TimedOut.

      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

      StartSimulationJobBatchResponse.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.
    • 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

      The batch policy.

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

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

      Parameters:
      batchPolicy - a consumer that will call methods on BatchPolicy.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

      StartSimulationJobBatchResponse.Builder failureReason(String 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

      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

      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

      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 the FailedCreateSimulationJobRequest.Builder avoiding the need to create one manually via FailedCreateSimulationJobRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failedRequests(List<FailedCreateSimulationJobRequest>).

      Parameters:
      failedRequests - a consumer that will call methods on FailedCreateSimulationJobRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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 the SimulationJobRequest.Builder avoiding the need to create one manually via SimulationJobRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingRequests(List<SimulationJobRequest>).

      Parameters:
      pendingRequests - a consumer that will call methods on SimulationJobRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      A list of created simulation job request summaries.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createdRequests(List<SimulationJobSummary>).

      Parameters:
      createdRequests - a consumer that will call methods on SimulationJobSummary.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.