Class CreateWorkflowRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateWorkflowRequest.Builder,
CreateWorkflowRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Accelerators
The computational accelerator specified to run the workflow.final String
The computational accelerator specified to run the workflow.builder()
final DefinitionRepository
The repository information for the workflow definition.final String
The S3 URI of a definition for the workflow.final SdkBytes
A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow.final String
A description for the workflow.final WorkflowEngine
engine()
The workflow engine for the workflow.final String
The workflow engine for the workflow.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ParameterTemplate property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
main()
The path of the main definition file for the workflow.final String
name()
Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.final Map
<String, WorkflowParameter> A parameter template for the workflow.final String
The path to the workflow parameter template JSON file within the repository.final String
The markdown content for the workflow's README file.final String
The path to the workflow README markdown file within the repository.final String
The S3 URI of the README file for the workflow.final String
An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.static Class
<? extends CreateWorkflowRequest.Builder> final Integer
The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.final StorageType
The default storage type for runs that use this workflow.final String
The default storage type for runs that use this workflow.tags()
Tags for the workflow.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.
- Returns:
- Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.
-
description
A description for the workflow.
- Returns:
- A description for the workflow.
-
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.
If the service returns an enum value that is not available in the current SDK version,
engine
will returnWorkflowEngine.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineAsString()
.- Returns:
- 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.
- See Also:
-
engineAsString
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.
If the service returns an enum value that is not available in the current SDK version,
engine
will returnWorkflowEngine.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineAsString()
.- Returns:
- 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.
- 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.
- Returns:
- 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.
-
definitionUri
The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.
- Returns:
- The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.
-
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:
- 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
.
-
hasParameterTemplate
public final boolean hasParameterTemplate()For responses, this returns true if the service returned a value for the ParameterTemplate property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasParameterTemplate()
method.- Returns:
- 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.
-
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.- Returns:
- 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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
requestId
An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
- Returns:
- An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
-
accelerators
The computational accelerator specified to run the workflow.
If the service returns an enum value that is not available in the current SDK version,
accelerators
will returnAccelerators.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceleratorsAsString()
.- Returns:
- The computational accelerator specified to run the workflow.
- See Also:
-
acceleratorsAsString
The computational accelerator specified to run the workflow.
If the service returns an enum value that is not available in the current SDK version,
accelerators
will returnAccelerators.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceleratorsAsString()
.- Returns:
- The computational accelerator specified to run the workflow.
- 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.If the service returns an enum value that is not available in the current SDK version,
storageType
will returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- 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. - See Also:
-
storageTypeAsString
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.If the service returns an enum value that is not available in the current SDK version,
storageType
will returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- 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. - See Also:
-
readmeMarkdown
The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- Returns:
- The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
-
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:
- 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.
-
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:
- 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.
-
definitionRepository
The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.
- Returns:
- The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.
-
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:
- 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.
-
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:
- 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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateWorkflowRequest.Builder,
CreateWorkflowRequest> - Specified by:
toBuilder
in classOmicsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-