Interface StartRunRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartRunRequest.Builder,StartRunRequest>, OmicsRequest.Builder, SdkBuilder<StartRunRequest.Builder,StartRunRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartRunRequest
@Mutable @NotThreadSafe 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.

    • cacheId

      StartRunRequest.Builder cacheId(String cacheId)

      Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.

      Parameters:
      cacheId - Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheBehavior

      StartRunRequest.Builder cacheBehavior(String cacheBehavior)

      The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      cacheBehavior - The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cacheBehavior

      StartRunRequest.Builder cacheBehavior(CacheBehavior cacheBehavior)

      The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      cacheBehavior - The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

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

      Parameters:
      storageCapacity - The static storage capacity (in gibibytes) for this run. 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. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      retentionMode - The retention mode for the run. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

      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. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      retentionMode - The retention mode for the run. The default value is RETAIN.

      Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

      For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      StartRunRequest.Builder storageType(String storageType)

      The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      storageType - The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      StartRunRequest.Builder storageType(StorageType storageType)

      The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      storageType - The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
      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.

    • workflowVersionName

      StartRunRequest.Builder workflowVersionName(String workflowVersionName)

      The name of the workflow version.

      Parameters:
      workflowVersionName - The name of the workflow version.
      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.