Interface DefaultRunSetting.Builder

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

  • Method Details

    • workflowId

      DefaultRunSetting.Builder workflowId(String workflowId)

      The identifier of the workflow to run.

      Parameters:
      workflowId - The identifier of the workflow to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowType

      DefaultRunSetting.Builder workflowType(String workflowType)

      The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

      Parameters:
      workflowType - The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workflowType

      DefaultRunSetting.Builder workflowType(WorkflowType workflowType)

      The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

      Parameters:
      workflowType - The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      DefaultRunSetting.Builder roleArn(String roleArn)

      The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

      Parameters:
      roleArn - The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      DefaultRunSetting.Builder name(String name)

      An optional user-friendly name applied to each workflow run. Can be overridden per run.

      Parameters:
      name - An optional user-friendly name applied to each workflow run. Can be overridden per run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheId

      DefaultRunSetting.Builder cacheId(String cacheId)

      The identifier of the run cache to associate with the runs.

      Parameters:
      cacheId - The identifier of the run cache to associate with the runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheBehavior

      DefaultRunSetting.Builder cacheBehavior(String cacheBehavior)

      The cache behavior for the runs. Requires cacheId to be set.

      Parameters:
      cacheBehavior - The cache behavior for the runs. Requires cacheId to be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cacheBehavior

      DefaultRunSetting.Builder cacheBehavior(CacheBehavior cacheBehavior)

      The cache behavior for the runs. Requires cacheId to be set.

      Parameters:
      cacheBehavior - The cache behavior for the runs. Requires cacheId to be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runGroupId

      DefaultRunSetting.Builder runGroupId(String runGroupId)

      The ID of the run group to contain all workflow runs in the batch.

      Parameters:
      runGroupId - The ID of the run group to contain all workflow runs in the batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      DefaultRunSetting.Builder priority(Integer priority)

      An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

      Parameters:
      priority - An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      DefaultRunSetting.Builder parameters(Document parameters)

      Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

      Parameters:
      parameters - Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCapacity

      DefaultRunSetting.Builder storageCapacity(Integer storageCapacity)

      The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

      Parameters:
      storageCapacity - The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputUri

      DefaultRunSetting.Builder outputUri(String outputUri)

      The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

      Parameters:
      outputUri - The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logLevel

      DefaultRunSetting.Builder logLevel(String logLevel)

      The verbosity level for CloudWatch Logs emitted during each run.

      Parameters:
      logLevel - The verbosity level for CloudWatch Logs emitted during each run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logLevel

      DefaultRunSetting.Builder logLevel(RunLogLevel logLevel)

      The verbosity level for CloudWatch Logs emitted during each run.

      Parameters:
      logLevel - The verbosity level for CloudWatch Logs emitted during each run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runTags

      DefaultRunSetting.Builder runTags(Map<String,String> runTags)

      AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

      Parameters:
      runTags - AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionMode

      DefaultRunSetting.Builder retentionMode(String retentionMode)

      The retention behavior for runs after completion.

      Parameters:
      retentionMode - The retention behavior for runs after completion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • retentionMode

      DefaultRunSetting.Builder retentionMode(RunRetentionMode retentionMode)

      The retention behavior for runs after completion.

      Parameters:
      retentionMode - The retention behavior for runs after completion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      DefaultRunSetting.Builder storageType(String storageType)

      The storage type for the workflow runs.

      Parameters:
      storageType - The storage type for the workflow runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      DefaultRunSetting.Builder storageType(StorageType storageType)

      The storage type for the workflow runs.

      Parameters:
      storageType - The storage type for the workflow runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workflowOwnerId

      DefaultRunSetting.Builder workflowOwnerId(String workflowOwnerId)

      The AWS account ID of the workflow owner, used for cross-account workflow sharing.

      Parameters:
      workflowOwnerId - The AWS account ID of the workflow owner, used for cross-account workflow sharing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputBucketOwnerId

      DefaultRunSetting.Builder outputBucketOwnerId(String outputBucketOwnerId)

      The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

      Parameters:
      outputBucketOwnerId - The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowVersionName

      DefaultRunSetting.Builder workflowVersionName(String workflowVersionName)

      The version name of the specified workflow.

      Parameters:
      workflowVersionName - The version name of the specified workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.