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. The workflowId is not the UUID.

      Parameters:
      workflowId - The run's workflow ID. The workflowId is not the UUID.
      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. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.

      Parameters:
      workflowType - The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the 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. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.

      Parameters:
      workflowType - The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the 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. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.

      Parameters:
      roleArn - A service role for the run. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.
      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. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.

      Parameters:
      name - A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.
      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. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.

      Parameters:
      runGroupId - The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      StartRunRequest.Builder priority(Integer priority)

      Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      priority - Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.
      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. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.

      Parameters:
      parameters - Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.
      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, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. 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, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. 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 S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.

      Parameters:
      outputUri - An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.
      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. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      tags - Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestId

      StartRunRequest.Builder requestId(String requestIdValue)

      An idempotency token used to dedupe retry requests so that duplicate runs are not created.

      Parameters:
      requestIdValue - An idempotency token used to dedupe retry requests so that duplicate runs are not created.
      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. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.

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

      Parameters:
      storageType - The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types 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 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

      Parameters:
      workflowOwnerId - The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.
      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. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      workflowVersionName - The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.
      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.