Class GetWorkflowResponse

    • Method Detail

      • 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.
      • 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:
        WorkflowType
      • 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.
      • 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 workflow's default run storage capacity in gibibytes.

        Returns:
        The workflow's default run storage capacity in gibibytes.
      • 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 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 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:
        Accelerators
      • 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:
        Accelerators
      • 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