final class ZWorkflowClient extends AnyRef

Represents Temporal workflow client

See also

WorkflowClient

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZWorkflowClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fetchHistory(workflowId: String, runId: Option[String] = None): Task[ZWorkflowExecutionHistory]

    Downloads workflow execution history for the provided workflowId.

    Downloads workflow execution history for the provided workflowId.

    workflowId

    Workflow Id of the workflow to export the history for

    runId

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

    returns

    execution history of the workflow with the specified Workflow Id.

    See also

    streamHistory for a lazy memory-efficient version of this method

  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def getWorkerBuildIdCompatibility(taskQueue: String): TemporalIO[ZWorkerBuildIdVersionSets]

    Returns the worker-build-id based version sets for a particular task queue.

    Returns the worker-build-id based version sets for a particular task queue.

    taskQueue

    The task queue to fetch the version set(s) of.

    returns

    The version set(s) for the task queue.

    Exceptions thrown

    io.temporal.client.WorkflowServiceException for any failures including networking and service availability issues.

    Note

    experimental in Java SDK

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def newActivityCompletionClient: UIO[ActivityCompletionClient]

    Creates new ActivityCompletionClient

    Creates new ActivityCompletionClient

    See also

    ActivityCompletionClient

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

    Creates workflow untyped client stub for a known execution.

    Creates workflow untyped client stub for a known execution. Use it to send signals or queries to a running workflow. Do not call methods annotated with @zio.temporal.workflowMethod.

    workflowId

    workflow id and optional run id for execution

    runId

    runId of the workflow execution. If not provided the last workflow with the given workflowId is assumed.

    returns

    Stub that can be used to start workflow and later to signal or query it.

  16. def newUntypedWorkflowStub(workflowType: String, options: ZWorkflowOptions): UIO[Untyped]

    Creates workflow untyped client stub that can be used to start a single workflow execution.

    Creates workflow untyped client stub that can be used to start a single workflow execution. After workflow is started it can be also used to send signals or queries to it. IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.

    workflowType

    name of the workflow type

    options

    options used to start a workflow through returned stub

    returns

    Stub that can be used to start workflow and later to signal or query it.

  17. def newWorkflowStub[A](workflowId: String, runId: Option[String] = None)(implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): UIO[ZWorkflowStub.Of[A]]

    Creates workflow client stub for a known execution.

    Creates workflow client stub for a known execution. Use it to send signals or queries to a running workflow. Do not call methods annotated with @zio.temporal.workflowMethod.

    A

    interface that given workflow implements.

    workflowId

    Workflow id.

    runId

    Run id of the workflow execution.

    returns

    Stub that implements workflowInterface and can be used to signal or query it.

  18. def newWorkflowStub[A](options: ZWorkflowOptions)(implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): UIO[ZWorkflowStub.Of[A]]

    Creates workflow client stub that can be used to start a single workflow execution.

    Creates workflow client stub that can be used to start a single workflow execution. The first call must be to a method annotated with @zio.temporal.workflowMethod. After workflow is started it can be also used to send signals or queries to it. IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.

    A

    interface that given workflow implements

    options

    options that will be used to configure and start a new workflow.

    returns

    Stub that implements workflowInterface and can be used to start workflow and signal or query it after the start.

  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. def streamExecutions(query: Option[String] = None): Stream[Throwable, ZWorkflowExecutionMetadata]

    A wrapper around {WorkflowServiceStub#listWorkflowExecutions(ListWorkflowExecutionsRequest)}

    A wrapper around {WorkflowServiceStub#listWorkflowExecutions(ListWorkflowExecutionsRequest)}

    query

    Temporal Visibility Query, for syntax see Visibility docs

    returns

    sequential stream that performs remote pagination under the hood

  22. def streamHistory(workflowId: String, runId: Option[String] = None): 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.

    workflowId

    Workflow Id of the workflow to export the history for

    runId

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

    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

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val toJava: WorkflowClient
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def updateWorkerBuildIdCompatibility(taskQueue: String, operation: BuildIdOperation): TemporalIO[Unit]

    Allows you to update the worker-build-id based version sets for a particular task queue.

    Allows you to update the worker-build-id based version sets for a particular task queue. This is used in conjunction with workers who specify their build id and thus opt into the feature.

    taskQueue

    The task queue to update the version set(s) of.

    operation

    The operation to perform. See BuildIdOperation for more.

    Exceptions thrown

    io.temporal.client.WorkflowServiceException for any failures including networking and service availability issues.

    Note

    experimental in Java SDK

  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def newUntypedWorkflowStub(workflowType: String): Untyped

    Creates new untyped type workflow stub builder

    Creates new untyped type workflow stub builder

    workflowType

    name of the workflow type

    returns

    builder instance

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use newUntypedWorkflowStub accepting ZWorkerOptions

  3. def newWorkflowStub[A](implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): Of[A]

    Creates new typed workflow stub builder

    Creates new typed workflow stub builder

    A

    workflow interface

    returns

    builder instance

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use newWorkflowStub accepting ZWorkerOptions

Inherited from AnyRef

Inherited from Any

Ungrouped