Interface CreateWorkflowRequest.Builder

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

  • Method Details

    • name

      CreateWorkflowRequest.Builder name(String name)

      Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.

      Parameters:
      name - Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateWorkflowRequest.Builder description(String description)

      A description for the workflow.

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

    • engine

      CreateWorkflowRequest.Builder engine(String engine)

      The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.

      Parameters:
      engine - The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engine

      CreateWorkflowRequest.Builder engine(WorkflowEngine engine)

      The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.

      Parameters:
      engine - The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • definitionZip

      CreateWorkflowRequest.Builder definitionZip(SdkBytes definitionZip)

      A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      definitionZip - A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definitionUri

      CreateWorkflowRequest.Builder definitionUri(String definitionUri)

      The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.

      Parameters:
      definitionUri - The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • main

      CreateWorkflowRequest.Builder main(String main)

      The path of the main definition file for the workflow. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: workflow-definition/main-file.wdl.

      Parameters:
      main - The path of the main definition file for the workflow. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: workflow-definition/main-file.wdl.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterTemplate

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

      A parameter template for the workflow. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see Parameter template files in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      parameterTemplate - A parameter template for the workflow. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see Parameter template files in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCapacity

      CreateWorkflowRequest.Builder storageCapacity(Integer storageCapacity)

      The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.

      Parameters:
      storageCapacity - The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      Tags for the workflow. You can define up to 50 tags for the workflow. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      tags - Tags for the workflow. You can define up to 50 tags for the workflow. 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

      CreateWorkflowRequest.Builder requestId(String requestIdValue)

      An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.

      Parameters:
      requestIdValue - An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accelerators

      CreateWorkflowRequest.Builder accelerators(String accelerators)

      The computational accelerator specified to run the workflow.

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

    • accelerators

      CreateWorkflowRequest.Builder accelerators(Accelerators accelerators)

      The computational accelerator specified to run the workflow.

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

    • storageType

      CreateWorkflowRequest.Builder storageType(String storageType)

      The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      storageType - The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, 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

      CreateWorkflowRequest.Builder storageType(StorageType storageType)

      The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      storageType - The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, 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:

    • containerRegistryMap

      CreateWorkflowRequest.Builder containerRegistryMap(ContainerRegistryMap containerRegistryMap)

      (Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.

      Parameters:
      containerRegistryMap - (Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerRegistryMap

      default CreateWorkflowRequest.Builder containerRegistryMap(Consumer<ContainerRegistryMap.Builder> containerRegistryMap)

      (Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.

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

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

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

    • containerRegistryMapUri

      CreateWorkflowRequest.Builder containerRegistryMapUri(String containerRegistryMapUri)

      (Optional) URI of the S3 location for the registry mapping file.

      Parameters:
      containerRegistryMapUri - (Optional) URI of the S3 location for the registry mapping file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readmeMarkdown

      CreateWorkflowRequest.Builder readmeMarkdown(String readmeMarkdown)

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

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

    • parameterTemplatePath

      CreateWorkflowRequest.Builder parameterTemplatePath(String parameterTemplatePath)

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

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

    • readmePath

      CreateWorkflowRequest.Builder readmePath(String readmePath)

      The path to the workflow 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 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

      CreateWorkflowRequest.Builder definitionRepository(DefinitionRepository definitionRepository)

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

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

    • definitionRepository

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

      The repository information for the workflow definition. This allows you to source your workflow 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:

    • workflowBucketOwnerId

      CreateWorkflowRequest.Builder workflowBucketOwnerId(String workflowBucketOwnerId)

      The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation.

      Parameters:
      workflowBucketOwnerId - The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readmeUri

      CreateWorkflowRequest.Builder readmeUri(String readmeUri)

      The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. 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. This file provides documentation and usage information for the workflow. 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

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

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