Interface CreateWorkflowVersionRequest.Builder

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

  • Method Details

    • workflowId

      CreateWorkflowVersionRequest.Builder workflowId(String workflowId)

      The ID of the workflow where you are creating the new version.

      Parameters:
      workflowId - The ID of the workflow where you are creating the new version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionName

      CreateWorkflowVersionRequest.Builder versionName(String versionName)

      A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

      The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.

      Parameters:
      versionName - A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

      The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.

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

    • definitionZip

      CreateWorkflowVersionRequest.Builder definitionZip(SdkBytes definitionZip)

      A zip archive containing the workflow definition for this workflow version.

      Parameters:
      definitionZip - A zip archive containing the workflow definition for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definitionUri

      CreateWorkflowVersionRequest.Builder definitionUri(String definitionUri)

      The URI specifies the location of the workflow definition for this workflow version.

      Parameters:
      definitionUri - The URI specifies the location of the workflow definition for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accelerators

      CreateWorkflowVersionRequest.Builder accelerators(String accelerators)

      The computational accelerator for this workflow version.

      Parameters:
      accelerators - The computational accelerator for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accelerators

      CreateWorkflowVersionRequest.Builder accelerators(Accelerators accelerators)

      The computational accelerator for this workflow version.

      Parameters:
      accelerators - The computational accelerator for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateWorkflowVersionRequest.Builder description(String description)

      A description for this workflow version.

      Parameters:
      description - A description for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engine

      CreateWorkflowVersionRequest.Builder engine(String engine)

      The workflow engine for this workflow version.

      Parameters:
      engine - The workflow engine for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engine

      CreateWorkflowVersionRequest.Builder engine(WorkflowEngine engine)

      The workflow engine for this workflow version.

      Parameters:
      engine - The workflow engine for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • main

      CreateWorkflowVersionRequest.Builder main(String main)

      The path of the main definition file for this workflow version.

      Parameters:
      main - The path of the main definition file for this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterTemplate

      CreateWorkflowVersionRequest.Builder parameterTemplate(Map<String,WorkflowParameter> parameterTemplate)

      The parameter template defines the input parameters for runs that use this workflow version.

      Parameters:
      parameterTemplate - The parameter template defines the input parameters for runs that use this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestId

      CreateWorkflowVersionRequest.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.

    • storageType

      CreateWorkflowVersionRequest.Builder storageType(String storageType)

      The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage 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 default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage 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

      CreateWorkflowVersionRequest.Builder storageType(StorageType storageType)

      The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage 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 default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage 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:

    • storageCapacity

      CreateWorkflowVersionRequest.Builder storageCapacity(Integer storageCapacity)

      The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

      Parameters:
      storageCapacity - The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      Optional tags to associate with this workflow version.

      Parameters:
      tags - Optional tags to associate with this workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowBucketOwnerId

      CreateWorkflowVersionRequest.Builder workflowBucketOwnerId(String workflowBucketOwnerId)

      Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

      Parameters:
      workflowBucketOwnerId - Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readmeMarkdown

      CreateWorkflowVersionRequest.Builder readmeMarkdown(String readmeMarkdown)

      The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

      Parameters:
      readmeMarkdown - The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterTemplatePath

      CreateWorkflowVersionRequest.Builder parameterTemplatePath(String parameterTemplatePath)

      The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.

      Parameters:
      parameterTemplatePath - The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readmePath

      CreateWorkflowVersionRequest.Builder readmePath(String readmePath)

      The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

      Parameters:
      readmePath - The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definitionRepository

      CreateWorkflowVersionRequest.Builder definitionRepository(DefinitionRepository definitionRepository)

      The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.

      Parameters:
      definitionRepository - The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definitionRepository

      default CreateWorkflowVersionRequest.Builder definitionRepository(Consumer<DefinitionRepository.Builder> definitionRepository)

      The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.

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

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

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

    • readmeUri

      CreateWorkflowVersionRequest.Builder readmeUri(String readmeUri)

      The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:

      • The S3 URI must begin with s3://USER-OWNED-BUCKET/

      • The requester must have access to the S3 bucket and object.

      • The max README content length is 500 KiB.

      Parameters:
      readmeUri - The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:

      • The S3 URI must begin with s3://USER-OWNED-BUCKET/

      • The requester must have access to the S3 bucket and object.

      • The max README content length is 500 KiB.

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

    • overrideConfiguration

      CreateWorkflowVersionRequest.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

      CreateWorkflowVersionRequest.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.