Class GetRunResponse

    • Method Detail

      • arn

        public final String arn()

        The run's ARN.

        Returns:
        The run's ARN.
      • id

        public final String id()

        The run's ID.

        Returns:
        The run's ID.
      • workflowId

        public final String workflowId()

        The run's workflow ID.

        Returns:
        The run's workflow ID.
      • runId

        public final String runId()

        The run's ID.

        Returns:
        The run's ID.
      • roleArn

        public final String roleArn()

        The run's service role ARN.

        Returns:
        The run's service role ARN.
      • name

        public final String name()

        The run's name.

        Returns:
        The run's name.
      • runGroupId

        public final String runGroupId()

        The run's group ID.

        Returns:
        The run's group ID.
      • priority

        public final Integer priority()

        The run's priority.

        Returns:
        The run's priority.
      • definition

        public final String definition()

        The run's definition.

        Returns:
        The run's definition.
      • digest

        public final String digest()

        The run's digest.

        Returns:
        The run's digest.
      • parameters

        public final Document parameters()

        The run's parameters.

        Returns:
        The run's parameters.
      • storageCapacity

        public final Integer storageCapacity()

        The run's storage capacity in gigabytes.

        Returns:
        The run's storage capacity in gigabytes.
      • outputUri

        public final String outputUri()

        The run's output URI.

        Returns:
        The run's output URI.
      • hasResourceDigests

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

        public final Map<String,​String> resourceDigests()

        The run's resource digests.

        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 hasResourceDigests() method.

        Returns:
        The run's resource digests.
      • startedBy

        public final String startedBy()

        Who started the run.

        Returns:
        Who started the run.
      • creationTime

        public final Instant creationTime()

        When the run was created.

        Returns:
        When the run was created.
      • startTime

        public final Instant startTime()

        When the run started.

        Returns:
        When the run started.
      • stopTime

        public final Instant stopTime()

        The run's stop time.

        Returns:
        The run's stop time.
      • statusMessage

        public final String statusMessage()

        The run's status message.

        Returns:
        The run'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 run'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 run's tags.
      • acceleratorsAsString

        public final String acceleratorsAsString()

        The computational accelerator used 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 used to run the workflow.
        See Also:
        Accelerators
      • failureReason

        public final String failureReason()

        The reason a run has failed.

        Returns:
        The reason a run has failed.
      • logLocation

        public final RunLogLocation logLocation()

        The location of the run log.

        Returns:
        The location of the run log.
      • uuid

        public final String uuid()

        The universally unique identifier for a run.

        Returns:
        The universally unique identifier for a run.
      • runOutputUri

        public final String runOutputUri()

        The destination for workflow outputs.

        Returns:
        The destination for workflow outputs.
      • 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