ZWorkflowClient

zio.temporal.workflow.ZWorkflowClient
See theZWorkflowClient companion object
final class ZWorkflowClient

Represents temporal workflow client

Attributes

See also

WorkflowClient

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def fetchHistory(workflowId: String, runId: Option[String]): Task[ZWorkflowExecutionHistory]

Downloads workflow execution history for the provided workflowId.

Downloads workflow execution history for the provided workflowId.

Value parameters

runId

Fixed Run Id of the workflow to export the history for. If not provided, the latest run will be used. Optional

workflowId

Workflow Id of the workflow to export the history for

Attributes

Returns

execution history of the workflow with the specified Workflow Id.

See also

streamHistory for a lazy memory-efficient version of this method

def newActivityCompletionClient: UIO[ActivityCompletionClient]

Creates new ActivityCompletionClient

Creates new ActivityCompletionClient

Attributes

See also

ActivityCompletionClient

def newUntypedWorkflowStub(workflowType: String): Untyped

Creates new untyped type workflow stub builder

Creates new untyped type workflow stub builder

Value parameters

workflowType

name of the workflow type

Attributes

Returns

builder instance

def newUntypedWorkflowStub(workflowId: String, runId: Option[String]): UIO[Untyped]

Creates new typed workflow stub builder

Creates new typed workflow stub builder

Type parameters

A

workflow interface

Attributes

Returns

builder instance

def newWorkflowStub[A : IsWorkflow](workflowId: String, runId: Option[String]): UIO[Of[A]]
def streamExecutions(query: Option[String]): Stream[Throwable, ZWorkflowExecutionMetadata]

A wrapper around {WorkflowServiceStub#listWorkflowExecutions(ListWorkflowExecutionsRequest)}

A wrapper around {WorkflowServiceStub#listWorkflowExecutions(ListWorkflowExecutionsRequest)}

Value parameters

query

Temporal Visibility Query, for syntax see Visibility docs

Attributes

Returns

sequential stream that performs remote pagination under the hood

def streamHistory(workflowId: String, runId: Option[String]): Stream[Throwable, ZHistoryEvent]

Streams history events for a workflow execution for the provided workflowId.

Streams history events for a workflow execution for the provided workflowId.

Value parameters

runId

Fixed Run Id of the workflow to export the history for. If not provided, the latest run will be used. Optional

workflowId

Workflow Id of the workflow to export the history for

Attributes

Returns

stream of history events of the specified run of the workflow execution.

See also

fetchHistory for a user-friendly eager version of this method

Concrete fields

val toJava: WorkflowClient