Class WorkflowRun

    • Method Detail

      • name

        public final String name()

        Name of the workflow that was run.

        Returns:
        Name of the workflow that was run.
      • workflowRunId

        public final String workflowRunId()

        The ID of this workflow run.

        Returns:
        The ID of this workflow run.
      • previousRunId

        public final String previousRunId()

        The ID of the previous workflow run.

        Returns:
        The ID of the previous workflow run.
      • hasWorkflowRunProperties

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

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

        The workflow run properties which were set during the run.

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

        Returns:
        The workflow run properties which were set during the run.
      • startedOn

        public final Instant startedOn()

        The date and time when the workflow run was started.

        Returns:
        The date and time when the workflow run was started.
      • completedOn

        public final Instant completedOn()

        The date and time when the workflow run completed.

        Returns:
        The date and time when the workflow run completed.
      • errorMessage

        public final String errorMessage()

        This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."

        Returns:
        This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."
      • statistics

        public final WorkflowRunStatistics statistics()

        The statistics of the run.

        Returns:
        The statistics of the run.
      • graph

        public final WorkflowGraph graph()

        The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

        Returns:
        The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
      • startingEventBatchCondition

        public final StartingEventBatchCondition startingEventBatchCondition()

        The batch condition that started the workflow run.

        Returns:
        The batch condition that started the workflow run.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)