Interface CreateWorkflowRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWorkflowRequest.Builder,
,CreateWorkflowRequest> OmicsRequest.Builder
,SdkBuilder<CreateWorkflowRequest.Builder,
,CreateWorkflowRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateWorkflowRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccelerators
(String accelerators) The computational accelerator specified to run the workflow.accelerators
(Accelerators accelerators) The computational accelerator specified to run the workflow.default CreateWorkflowRequest.Builder
definitionRepository
(Consumer<DefinitionRepository.Builder> definitionRepository) The repository information for the workflow definition.definitionRepository
(DefinitionRepository definitionRepository) The repository information for the workflow definition.definitionUri
(String definitionUri) The S3 URI of a definition for the workflow.definitionZip
(SdkBytes definitionZip) A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow.description
(String description) A description for the workflow.The workflow engine for the workflow.engine
(WorkflowEngine engine) The workflow engine for the workflow.The path of the main definition file for the workflow.Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameterTemplate
(Map<String, WorkflowParameter> parameterTemplate) A parameter template for the workflow.parameterTemplatePath
(String parameterTemplatePath) The path to the workflow parameter template JSON file within the repository.readmeMarkdown
(String readmeMarkdown) The markdown content for the workflow's README file.readmePath
(String readmePath) The path to the workflow README markdown file within the repository.The S3 URI of the README file for the workflow.An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.storageCapacity
(Integer storageCapacity) The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.storageType
(String storageType) The default storage type for runs that use this workflow.storageType
(StorageType storageType) The default storage type for runs that use this workflow.Tags for the workflow.workflowBucketOwnerId
(String workflowBucketOwnerId) The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.omics.model.OmicsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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 aDYNAMIC
storage type.- Parameters:
storageCapacity
- The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. ThestorageCapacity
can be overwritten at run time. The storage capacity is not required for runs with aDYNAMIC
storage type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
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
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. ThestorageType
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
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. ThestorageType
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:
-
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
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
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, theREADME.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
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 theDefinitionRepository.Builder
avoiding the need to create one manually viaDefinitionRepository.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefinitionRepository(DefinitionRepository)
.- Parameters:
definitionRepository
- a consumer that will call methods onDefinitionRepository.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-