Interface CreateWorkflowVersionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWorkflowVersionRequest.Builder,
,CreateWorkflowVersionRequest> OmicsRequest.Builder
,SdkBuilder<CreateWorkflowVersionRequest.Builder,
,CreateWorkflowVersionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateWorkflowVersionRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccelerators
(String accelerators) The computational accelerator for this workflow version.accelerators
(Accelerators accelerators) The computational accelerator for this workflow version.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.containerRegistryMap
(ContainerRegistryMap containerRegistryMap) (Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.containerRegistryMapUri
(String containerRegistryMapUri) (Optional) URI of the S3 location for the registry mapping file.definitionRepository
(Consumer<DefinitionRepository.Builder> definitionRepository) The repository information for the workflow version definition.definitionRepository
(DefinitionRepository definitionRepository) The repository information for the workflow version definition.definitionUri
(String definitionUri) The S3 URI of a definition for this workflow version.definitionZip
(SdkBytes definitionZip) A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version.description
(String description) A description for this workflow version.The workflow engine for this workflow version.engine
(WorkflowEngine engine) The workflow engine for this workflow version.The path of the main definition file for this workflow version.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 this workflow version.parameterTemplatePath
(String parameterTemplatePath) The path to the workflow version parameter template JSON file within the repository.readmeMarkdown
(String readmeMarkdown) The markdown content for the workflow version's README file.readmePath
(String readmePath) The path to the workflow version README markdown file within the repository.The S3 URI of the README file for the workflow version.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 version.storageType
(String storageType) The default storage type for runs that use this workflow version.storageType
(StorageType storageType) The default storage type for runs that use this workflow version.Tags for this workflow version.versionName
(String versionName) A name for the workflow version.workflowBucketOwnerId
(String workflowBucketOwnerId) Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition.workflowId
(String workflowId) The ID of the workflow where you are creating the new version.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
-
workflowId
The ID of the workflow where you are creating the new version. The
workflowId
is not the UUID.- Parameters:
workflowId
- The ID of the workflow where you are creating the new version. TheworkflowId
is not the UUID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version. 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 this workflow version. 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 this workflow version. The S3 bucket must be in the same region as this workflow version.
- Parameters:
definitionUri
- The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
The workflow engine for this workflow version. 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 this workflow version. 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 this workflow version. 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 this workflow version. 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:
-
main
The path of the main definition file for this workflow version. 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 this workflow version. 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
CreateWorkflowVersionRequest.Builder parameterTemplate(Map<String, WorkflowParameter> parameterTemplate) A parameter template for this workflow version. 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 this workflow version. 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.
-
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.
-
storageType
The default storage type for runs that use this workflow version. 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 version. 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 version. 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 version. 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:
-
storageCapacity
The default static storage capacity (in gibibytes) for runs that use this 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 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 this workflow version. 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 this workflow version. 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.
-
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.
-
containerRegistryMap
CreateWorkflowVersionRequest.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 CreateWorkflowVersionRequest.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 theContainerRegistryMap.Builder
avoiding the need to create one manually viaContainerRegistryMap.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontainerRegistryMap(ContainerRegistryMap)
.- Parameters:
containerRegistryMap
- a consumer that will call methods onContainerRegistryMap.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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, 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
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 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:
-
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-