Interface GetBatchResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetBatchResponse.Builder,GetBatchResponse>, OmicsResponse.Builder, SdkBuilder<GetBatchResponse.Builder,GetBatchResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetBatchResponse
@Mutable @NotThreadSafe public static interface GetBatchResponse.Builder extends OmicsResponse.Builder, SdkPojo, CopyableBuilder<GetBatchResponse.Builder,GetBatchResponse>

  • Method Details

    • id

      GetBatchResponse.Builder id(String id)

      The identifier portion of the run batch ARN.

      Parameters:
      id - The identifier portion of the run batch ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      GetBatchResponse.Builder arn(String arn)

      The unique ARN of the run batch.

      Parameters:
      arn - The unique ARN of the run batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uuid

      GetBatchResponse.Builder uuid(String uuid)

      The universally unique identifier (UUID) for the run batch.

      Parameters:
      uuid - The universally unique identifier (UUID) for the run batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetBatchResponse.Builder name(String name)

      The optional user-friendly name of the batch.

      Parameters:
      name - The optional user-friendly name of the batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetBatchResponse.Builder status(String status)

      The current status of the run batch.

      Parameters:
      status - The current status of the run batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetBatchResponse.Builder status(BatchStatus status)

      The current status of the run batch.

      Parameters:
      status - The current status of the run batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      AWS tags associated with the run batch.

      Parameters:
      tags - AWS tags associated with the run batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalRuns

      GetBatchResponse.Builder totalRuns(Integer totalRuns)

      The total number of runs in the batch.

      Parameters:
      totalRuns - The total number of runs in the batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultRunSetting

      GetBatchResponse.Builder defaultRunSetting(DefaultRunSetting defaultRunSetting)

      The shared configuration applied to all runs in the batch. See DefaultRunSetting.

      Parameters:
      defaultRunSetting - The shared configuration applied to all runs in the batch. See DefaultRunSetting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultRunSetting

      default GetBatchResponse.Builder defaultRunSetting(Consumer<DefaultRunSetting.Builder> defaultRunSetting)

      The shared configuration applied to all runs in the batch. See DefaultRunSetting.

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

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

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

    • submissionSummary

      GetBatchResponse.Builder submissionSummary(SubmissionSummary submissionSummary)

      A summary of run submission outcomes. See SubmissionSummary.

      Parameters:
      submissionSummary - A summary of run submission outcomes. See SubmissionSummary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • submissionSummary

      default GetBatchResponse.Builder submissionSummary(Consumer<SubmissionSummary.Builder> submissionSummary)

      A summary of run submission outcomes. See SubmissionSummary.

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

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

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

    • runSummary

      GetBatchResponse.Builder runSummary(RunSummary runSummary)

      A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.

      Parameters:
      runSummary - A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runSummary

      default GetBatchResponse.Builder runSummary(Consumer<RunSummary.Builder> runSummary)

      A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.

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

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

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

    • creationTime

      GetBatchResponse.Builder creationTime(Instant creationTime)

      The timestamp when the batch was created.

      Parameters:
      creationTime - The timestamp when the batch was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • submittedTime

      GetBatchResponse.Builder submittedTime(Instant submittedTime)

      The timestamp when all run submissions completed.

      Parameters:
      submittedTime - The timestamp when all run submissions completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processedTime

      GetBatchResponse.Builder processedTime(Instant processedTime)

      The timestamp when all run executions completed.

      Parameters:
      processedTime - The timestamp when all run executions completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failedTime

      GetBatchResponse.Builder failedTime(Instant failedTime)

      The timestamp when the batch transitioned to a FAILED status.

      Parameters:
      failedTime - The timestamp when the batch transitioned to a FAILED status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReason

      GetBatchResponse.Builder failureReason(String failureReason)

      A description of the batch failure. Present only when status is FAILED.

      Parameters:
      failureReason - A description of the batch failure. Present only when status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.