Interface StartRunRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartRunRequest.Builder,StartRunRequest>, OmicsRequest.Builder, SdkBuilder<StartRunRequest.Builder,StartRunRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartRunRequest
public static interface StartRunRequest.Builder extends OmicsRequest.Builder, SdkPojo, CopyableBuilder<StartRunRequest.Builder,StartRunRequest>

  • Method Details

    • workflowId

      StartRunRequest.Builder workflowId(String workflowId)

      The run's workflow ID.

      Parameters:
      workflowId - The run's workflow ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowType

      StartRunRequest.Builder workflowType(String workflowType)

      The run's workflow type.

      Parameters:
      workflowType - The run's workflow type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workflowType

      StartRunRequest.Builder workflowType(WorkflowType workflowType)

      The run's workflow type.

      Parameters:
      workflowType - The run's workflow type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runId

      StartRunRequest.Builder runId(String runId)

      The ID of a run to duplicate.

      Parameters:
      runId - The ID of a run to duplicate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      StartRunRequest.Builder roleArn(String roleArn)

      A service role for the run.

      Parameters:
      roleArn - A service role for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartRunRequest.Builder name(String name)

      A name for the run.

      Parameters:
      name - A name for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runGroupId

      StartRunRequest.Builder runGroupId(String runGroupId)

      The run's group ID.

      Parameters:
      runGroupId - The run's group ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      StartRunRequest.Builder priority(Integer priority)

      A priority for the run.

      Parameters:
      priority - A priority for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      StartRunRequest.Builder parameters(Document parameters)

      Parameters for the run.

      Parameters:
      parameters - Parameters for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCapacity

      StartRunRequest.Builder storageCapacity(Integer storageCapacity)

      A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

      Parameters:
      storageCapacity - A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputUri

      StartRunRequest.Builder outputUri(String outputUri)

      An output URI for the run.

      Parameters:
      outputUri - An output URI for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logLevel

      StartRunRequest.Builder logLevel(String logLevel)

      A log level for the run.

      Parameters:
      logLevel - A log level for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logLevel

      StartRunRequest.Builder logLevel(RunLogLevel logLevel)

      A log level for the run.

      Parameters:
      logLevel - A log level for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      Tags for the run.

      Parameters:
      tags - Tags for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestId

      StartRunRequest.Builder requestId(String requestIdValue)

      To ensure that requests don't run multiple times, specify a unique ID for each request.

      Parameters:
      requestIdValue - To ensure that requests don't run multiple times, specify a unique ID for each request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionMode

      StartRunRequest.Builder retentionMode(String retentionMode)

      The retention mode for the run.

      Parameters:
      retentionMode - The retention mode for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • retentionMode

      StartRunRequest.Builder retentionMode(RunRetentionMode retentionMode)

      The retention mode for the run.

      Parameters:
      retentionMode - The retention mode for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      StartRunRequest.Builder storageType(String storageType)

      The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

      Parameters:
      storageType - The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      StartRunRequest.Builder storageType(StorageType storageType)

      The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

      Parameters:
      storageType - The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workflowOwnerId

      StartRunRequest.Builder workflowOwnerId(String workflowOwnerId)

      The ID of the workflow owner.

      Parameters:
      workflowOwnerId - The ID of the workflow owner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.