Package dev.cachly

Class WorkflowClient

java.lang.Object

dev.cachly.WorkflowClient

public class WorkflowClient
extends Object

Workflow checkpoint client for agent workflows. Obtain via CachlyClient.workflow().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WorkflowClient.Checkpoint	A single saved workflow checkpoint.
static final class	WorkflowClient.RunSummary	Summary of a workflow run (returned by listRuns()).
static final class	WorkflowClient.SaveOptions	Optional parameters for save(String, String, SaveOptions).

Method Summary

Modifier and Type	Method	Description
void	deleteRun(String runId)	Delete all checkpoints for a run.
List<WorkflowClient.Checkpoint>	getRun(String runId)	Get all checkpoints for a run.
WorkflowClient.Checkpoint	latest(String runId)	Get the latest checkpoint for a run.
List<WorkflowClient.RunSummary>	listRuns()	List all workflow runs.
WorkflowClient.Checkpoint	save(String runId, String stepName)	Save with default options.
WorkflowClient.Checkpoint	save(String runId, String stepName, WorkflowClient.SaveOptions opts)	Save a workflow checkpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

save

public WorkflowClient.Checkpoint save(String runId,
 String stepName,
 WorkflowClient.SaveOptions opts)
                               throws CachlyException

Save a workflow checkpoint. POST {workflowUrl}/checkpoints

Throws:

CachlyException

save

public WorkflowClient.Checkpoint save(String runId,
 String stepName)
                               throws CachlyException

Save with default options.

Throws:

CachlyException

listRuns

public List<WorkflowClient.RunSummary> listRuns()
                                         throws CachlyException

List all workflow runs. GET {workflowUrl}/runs

Throws:

CachlyException

getRun

public List<WorkflowClient.Checkpoint> getRun(String runId)
                                       throws CachlyException

Get all checkpoints for a run. GET {workflowUrl}/runs/:runId

Throws:

CachlyException

latest

public WorkflowClient.Checkpoint latest(String runId)
                                 throws CachlyException

Get the latest checkpoint for a run. GET {workflowUrl}/runs/:runId/latest

Throws:

CachlyException

deleteRun

public void deleteRun(String runId)
               throws CachlyException

Delete all checkpoints for a run. DELETE {workflowUrl}/runs/:runId

Throws:

CachlyException