Package com.atlan.model.workflow

Class WorkflowResponse

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.net.ApiResource
com.atlan.model.workflow.WorkflowResponse
All Implemented Interfaces:
AtlanResponseInterface, Serializable
Direct Known Subclasses:
WorkflowRunResponse
public class WorkflowResponse extends ApiResource
See Also:

  • Constructor Details

    • WorkflowResponse

      public WorkflowResponse()

  • Method Details

    • monitorStatus

      public AtlanWorkflowPhase monitorStatus() throws AtlanException, InterruptedException
      Monitor the status of the workflow's run, blocking until it has completed. Note that this variation of the method will not log any activity, but will simply block until the workflow completes.
      Returns:
      the status at completion, or null if the workflow was not even run
      Throws:
      AtlanException - on any errors running the workflow
      InterruptedException - on any interruption of the busy wait loop

    • monitorStatus

      public AtlanWorkflowPhase monitorStatus(org.slf4j.Logger log) throws AtlanException, InterruptedException
      Monitor the status of the workflow's run, blocking until it has completed.
      Parameters:
      log - through which to log status information (INFO-level, by default)
      Returns:
      the status at completion, or null if the workflow was not even run
      Throws:
      AtlanException - on any errors running the workflow
      InterruptedException - on any interruption of the busy wait loop

    • monitorStatus

      public AtlanWorkflowPhase monitorStatus(org.slf4j.Logger log, org.slf4j.event.Level level) throws AtlanException, InterruptedException
      Monitor the status of the workflow's run, blocking until it has completed.
      Parameters:
      log - through which to log status information (INFO-level)
      level - through which to log the status information
      Returns:
      the status at completion, or null if the workflow was not even run
      Throws:
      AtlanException - on any errors running the workflow
      InterruptedException - on any interruption of the busy wait loop

    • monitorStatus

      public AtlanWorkflowPhase monitorStatus(org.slf4j.Logger log, org.slf4j.event.Level level, long maxWaitTime) throws AtlanException, InterruptedException
      Monitor the status of the workflow's run, blocking until it has completed.
      Parameters:
      log - through which to log status information (INFO-level)
      level - through which to log the status information
      maxWaitTime - maximum time to block (in seconds), after which to stop monitoring and return
      Returns:
      the status at completion, or null if the workflow was not even run (or has not yet completed when returning)
      Throws:
      AtlanException - on any errors running the workflow
      InterruptedException - on any interruption of the busy wait loop

    • stop

      public WorkflowRunResponse stop() throws AtlanException
      Stop this workflow. Note: the result will be returned immediately (async), so you may need to further poll until the workflow is actually stopped.
      Returns:
      the result of the stop command, or null if there was no running workflow to stop
      Throws:
      AtlanException - on any API errors stopping the workflow run

    • getRunDetails

      protected WorkflowSearchResult getRunDetails(String name) throws AtlanException
      Retrieve the workflow run details.
      Parameters:
      name - of the workflow template
      Returns:
      the details of the workflow run
      Throws:
      AtlanException - on any API errors searching for the workflow run

    • getClient

      public AtlanClient getClient()
      Connectivity to the Atlan tenant where the workflow request was run.

    • getMetadata

      public WorkflowMetadata getMetadata()

    • getSpec

      public WorkflowSpec getSpec()

    • getPayload

      public List<Object> getPayload()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AtlanObject

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AtlanObject

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AtlanObject

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class ApiResource

    • setClient

      public void setClient(AtlanClient client)
      Connectivity to the Atlan tenant where the workflow request was run.