client

Documentation

Overview

Package client contains functions to create Cadence clients used to communicate to Cadence service.

Use these to perform CRUD on domains and start or query workflow executions.

Index

• Constants
• type Client
  • func NewClient(service workflowserviceclient.Interface, domain string, options *Options) Client
• type DomainClient
  • func NewDomainClient(service workflowserviceclient.Interface, options *Options) DomainClient
• type HistoryEventIterator
• type Options
• type StartWorkflowOptions
• type WorkflowIDReusePolicy
• type WorkflowRun

Constants

const QueryTypeStackTrace string = internal.QueryTypeStackTrace

QueryTypeStackTrace is the build in query type for Client.QueryWorkflow() call. Use this query type to get the call stack of the workflow. The result will be a string encoded in the encoded.Value.

Types

type Client

type Client = internal.Client

Client is the client for starting and getting information about a workflow executions as well as completing activities asynchronously.

func NewClient

func NewClient(service workflowserviceclient.Interface, domain string, options *Options) Client

NewClient creates an instance of a workflow client

type DomainClient

type DomainClient = internal.DomainClient

DomainClient is the client for managing operations on the domain. CLI, tools, ... can use this layer to manager operations on domain.

func NewDomainClient

func NewDomainClient(service workflowserviceclient.Interface, options *Options) DomainClient

NewDomainClient creates an instance of a domain client, to manage lifecycle of domains.

type HistoryEventIterator

type HistoryEventIterator = internal.HistoryEventIterator

HistoryEventIterator is a iterator which can return history events

type Options

type Options = internal.ClientOptions

Options are optional parameters for Client creation.

type StartWorkflowOptions

type StartWorkflowOptions = internal.StartWorkflowOptions

StartWorkflowOptions configuration parameters for starting a workflow execution.

type WorkflowIDReusePolicy

type WorkflowIDReusePolicy = internal.WorkflowIDReusePolicy

WorkflowIDReusePolicy defines workflow ID reuse behavior.

const (
	// WorkflowIDReusePolicyAllowDuplicateFailedOnly allow start a workflow execution
	// when workflow not running, and the last execution close state is in
	// [terminated, cancelled, timeouted, failed].
	WorkflowIDReusePolicyAllowDuplicateFailedOnly WorkflowIDReusePolicy = internal.WorkflowIDReusePolicyAllowDuplicateFailedOnly

	// WorkflowIDReusePolicyAllowDuplicate allow start a workflow execution using
	// the same workflow ID,when workflow not running.
	WorkflowIDReusePolicyAllowDuplicate WorkflowIDReusePolicy = internal.WorkflowIDReusePolicyAllowDuplicate

	// WorkflowIDReusePolicyRejectDuplicate do not allow start a workflow execution using the same workflow ID at all
	WorkflowIDReusePolicyRejectDuplicate WorkflowIDReusePolicy = internal.WorkflowIDReusePolicyRejectDuplicate
)

type WorkflowRun

type WorkflowRun = internal.WorkflowRun

WorkflowRun represents a started non child workflow