Class CreateWorkflowVersionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.omics.model.OmicsRequest
software.amazon.awssdk.services.omics.model.CreateWorkflowVersionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWorkflowVersionRequest.Builder,CreateWorkflowVersionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateWorkflowVersionRequest extends OmicsRequest implements ToCopyableBuilder<CreateWorkflowVersionRequest.Builder,CreateWorkflowVersionRequest>

  • Method Details

    • workflowId

      public final String workflowId()

      The ID of the workflow where you are creating the new version. The workflowId is not the UUID.

      Returns:
      The ID of the workflow where you are creating the new version. The workflowId is not the UUID.

    • versionName

      public final 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.

      Returns:
      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.

    • definitionZip

      public final SdkBytes 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:
      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.

    • definitionUri

      public final String 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:
      The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.

    • accelerators

      public final Accelerators accelerators()

      The computational accelerator for this workflow version.

      If the service returns an enum value that is not available in the current SDK version, accelerators will return Accelerators.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorsAsString().

      Returns:
      The computational accelerator for this workflow version.
      See Also:

    • acceleratorsAsString

      public final String acceleratorsAsString()

      The computational accelerator for this workflow version.

      If the service returns an enum value that is not available in the current SDK version, accelerators will return Accelerators.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorsAsString().

      Returns:
      The computational accelerator for this workflow version.
      See Also:

    • description

      public final String description()

      A description for this workflow version.

      Returns:
      A description for this workflow version.

    • engine

      public final WorkflowEngine 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.

      If the service returns an enum value that is not available in the current SDK version, engine will return WorkflowEngine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineAsString().

      Returns:
      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.
      See Also:

    • engineAsString

      public final String engineAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, engine will return WorkflowEngine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineAsString().

      Returns:
      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.
      See Also:

    • main

      public final String 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:
      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.

    • 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 the isEmpty() 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

      public final 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.

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

    • requestId

      public final String 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.

    • storageType

      public final StorageType 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.

      If the service returns an enum value that is not available in the current SDK version, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

      Returns:
      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.
      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

      Returns:
      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.
      See Also:

    • storageCapacity

      public final Integer 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 a DYNAMIC storage type.

      Returns:
      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 a DYNAMIC 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 the isEmpty() 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

      public final Map<String,String> 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.

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

    • workflowBucketOwnerId

      public final 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.

      Returns:
      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.

    • containerRegistryMap

      public final 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.

      Returns:
      (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.

    • containerRegistryMapUri

      public final String containerRegistryMapUri()

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

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

    • readmeMarkdown

      public final 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.

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

    • parameterTemplatePath

      public final 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.

      Returns:
      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.

    • readmePath

      public final 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.

      Returns:
      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.

    • definitionRepository

      public final DefinitionRepository definitionRepository()

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

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

    • readmeUri

      public final 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.

      Returns:
      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.

    • toBuilder

      public CreateWorkflowVersionRequest.Builder 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 interface ToCopyableBuilder<CreateWorkflowVersionRequest.Builder,CreateWorkflowVersionRequest>
      Specified by:
      toBuilder in class OmicsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateWorkflowVersionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWorkflowVersionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.