Package software.amazon.awssdk.services.omics.model

Class CreateWorkflowRequest

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.CreateWorkflowRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateWorkflowRequest extends OmicsRequest implements ToCopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>

  • Method Details

    • name

      public final String name()

      A name for the workflow.

      Returns:
      A name for the workflow.

    • description

      public final String description()

      A description for the workflow.

      Returns:
      A description for the workflow.

    • engine

      public final WorkflowEngine engine()

      An engine for the workflow.

      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:
      An engine for the workflow.
      See Also:

    • engineAsString

      public final String engineAsString()

      An engine for the workflow.

      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:
      An engine for the workflow.
      See Also:

    • definitionZip

      public final SdkBytes definitionZip()

      A ZIP archive for the workflow.

      Returns:
      A ZIP archive for the workflow.

    • definitionUri

      public final String definitionUri()

      The URI of a definition for the workflow.

      Returns:
      The URI of a definition for the workflow.

    • main

      public final String main()

      The path of the main definition file for the workflow.

      Returns:
      The path of the main definition file for the workflow.

    • 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 the workflow.

      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.

    • storageCapacity

      public final Integer storageCapacity()

      The storage capacity for the workflow in gibibytes.

      Returns:
      The storage capacity for the workflow in gibibytes.

    • 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 the workflow.

      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.

    • requestId

      public final String requestId()

      To ensure that requests don't run multiple times, specify a unique ID for each request.

      Returns:
      To ensure that requests don't run multiple times, specify a unique ID for each request.

    • accelerators

      public final Accelerators 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 return Accelerators.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorsAsString().

      Returns:
      The computational accelerator specified to run the workflow.
      See Also:

    • acceleratorsAsString

      public final String 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 return Accelerators.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorsAsString().

      Returns:
      The computational accelerator specified to run the workflow.
      See Also:

    • toBuilder

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

    • builder

      public static CreateWorkflowRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWorkflowRequest.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.