Interface StartSimulationJobBatchResponse.Builder

    • Method Detail

      • arn

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

        StartSimulationJobBatchResponse.Builder status​(String 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:
        SimulationJobBatchStatus, SimulationJobBatchStatus
      • status

        StartSimulationJobBatchResponse.Builder status​(SimulationJobBatchStatus 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:
        SimulationJobBatchStatus, SimulationJobBatchStatus
      • createdAt

        StartSimulationJobBatchResponse.Builder createdAt​(Instant 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.
      • 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

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

        StartSimulationJobBatchResponse.Builder pendingRequests​(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.
      • 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

        StartSimulationJobBatchResponse.Builder createdRequests​(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.
      • tags

        StartSimulationJobBatchResponse.Builder tags​(Map<String,​String> 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.