Class GetWorkflowResponse

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

  • Method Details

    • arn

      public final String arn()

      The workflow's ARN.

      Returns:
      The workflow's ARN.

    • id

      public final String id()

      The workflow's ID.

      Returns:
      The workflow's ID.

    • status

      public final WorkflowStatus status()

      The workflow's status.

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

      Returns:
      The workflow's status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The workflow's status.

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

      Returns:
      The workflow's status.
      See Also:

    • type

      public final WorkflowType type()

      The workflow's type.

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

      Returns:
      The workflow's type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The workflow's type.

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

      Returns:
      The workflow's type.
      See Also:

    • name

      public final String name()

      The workflow's name.

      Returns:
      The workflow's name.

    • description

      public final String description()

      The workflow's description.

      Returns:
      The workflow's description.

    • engine

      public final WorkflowEngine engine()

      The workflow's engine.

      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's engine.
      See Also:

    • engineAsString

      public final String engineAsString()

      The workflow's engine.

      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's engine.
      See Also:

    • definition

      public final String definition()

      The workflow's definition.

      Returns:
      The workflow's definition.

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

    • digest

      public final String digest()

      The workflow's digest.

      Returns:
      The workflow's digest.

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

      The workflow's parameter template.

      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:
      The workflow's parameter template.

    • storageCapacity

      public final Integer storageCapacity()

      The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

      Returns:
      The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

    • creationTime

      public final Instant creationTime()

      When the workflow was created.

      Returns:
      When the workflow was created.

    • statusMessage

      public final String statusMessage()

      The workflow's status message.

      Returns:
      The workflow's status message.

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

      The workflow's tags.

      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:
      The workflow's tags.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata 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.

    • metadata

      public final Map<String,String> metadata()

      Gets metadata 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 hasMetadata() method.

      Returns:
      Gets metadata for the workflow.

    • 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:

    • storageType

      public final StorageType storageType()

      The default storage type for runs using this workflow.

      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 using this workflow.
      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      The default storage type for runs using this workflow.

      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 using this workflow.
      See Also:

    • uuid

      public final String uuid()

      The universally unique identifier (UUID) value for this workflow.

      Returns:
      The universally unique identifier (UUID) value for this workflow.

    • containerRegistryMap

      public final ContainerRegistryMap containerRegistryMap()

      The registry map that this workflow is using.

      Returns:
      The registry map that this workflow is using.

    • readme

      public final String readme()

      The README content for the workflow, providing documentation and usage information.

      Returns:
      The README content for the workflow, providing documentation and usage information.

    • definitionRepositoryDetails

      public final DefinitionRepositoryDetails definitionRepositoryDetails()

      Details about the source code repository that hosts the workflow definition files.

      Returns:
      Details about the source code repository that hosts the workflow definition files.

    • readmePath

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

    • toBuilder

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

    • builder

      public static GetWorkflowResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.