A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://php.temporal.io/classes/Temporal-Client-WorkflowClient.html below:

Documentation

WorkflowClient implements WorkflowClientInterface uses ClientContextTrait WorkflowClient.php : 52 Table of Contents Interfaces
WorkflowClientInterface
Constants
ERROR_WORKFLOW_START_DUPLICATION  = 'Cannot reuse a stub instance to start more than one workflow execution. ' . 'The stub points to already started execution. If you are trying to wait ' . 'for a workflow completion either change WorkflowIdReusePolicy from ' . 'AllowDuplicate or use WorkflowStub.getResult'
Properties
$clientOptions  : ClientOptions
$converter  : DataConverterInterface
$interceptorPipeline  : Pipeline<WorkflowClientCallsInterceptor, mixed>
$reader  : WorkflowReader
$starter  : WorkflowStarter|null
Methods
__clone()  : mixed
__construct()  : mixed
countWorkflowExecutions()  : CountWorkflowExecutions
Get count of workflow executions using List Filter Query syntax.
create()  : static
getServiceClient()  : ServiceClientInterface
getWorkflowHistory()  : WorkflowExecutionHistory
listWorkflowExecutions()  : Paginator<string|int, WorkflowExecutionInfo>
Get paginated list of workflow executions using List Filter Query syntax.
newActivityCompletionClient()  : ActivityCompletionClientInterface
Creates a new `ActivityCompletionClient` that can be used to complete activities asynchronously.
newRunningWorkflowStub()  : T
Returns workflow stub associated with running workflow.
newUntypedRunningWorkflowStub()  : WorkflowStubInterface
Returns untyped workflow stub associated with running workflow.
newUntypedWorkflowStub()  : WorkflowStubInterface
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.
newWorkflowStub()  : T
Creates workflow client stub that can be used to start a single workflow execution.
signalWithStart()  : WorkflowRunInterface
Starts untyped and typed workflow stubs in async mode. Sends signal on start.
start()  : WorkflowRunInterface
Starts workflow in async mode.
startWithSignal()  : WorkflowRunInterface
updateWithStart()  : UpdateHandle
Starts untyped and typed workflow stubs in async mode. Sends Update on start.
createReader()  : ReaderInterface
getStarter()  : WorkflowStarter
ERROR_WORKFLOW_START_DUPLICATION WorkflowClient.php : 56 private mixed ERROR_WORKFLOW_START_DUPLICATION = 'Cannot reuse a stub instance to start more than one workflow execution. ' . 'The stub points to already started execution. If you are trying to wait ' . 'for a workflow completion either change WorkflowIdReusePolicy from ' . 'AllowDuplicate or use WorkflowStub.getResult' $clientOptions WorkflowClient.php : 62 private ClientOptions $clientOptions $converter WorkflowClient.php : 63 private DataConverterInterface $converter $interceptorPipeline WorkflowClient.php : 68 private Pipeline<WorkflowClientCallsInterceptor, mixed> $interceptorPipeline $reader WorkflowClient.php : 65 private WorkflowReader $reader $starter WorkflowClient.php : 64 private WorkflowStarter|null $starter = null __clone() WorkflowClient.php : 404 public __clone() : mixed __construct() WorkflowClient.php : 70 public __construct(ServiceClientInterface $serviceClient[, ClientOptions|null $options = null ][, DataConverterInterface|null $converter = null ][, PipelineProvider|null $interceptorProvider = null ]) : mixed Parameters
$serviceClient : ServiceClientInterface
$options : ClientOptions|null = null
$converter : DataConverterInterface|null = null
$interceptorProvider : PipelineProvider|null = null
countWorkflowExecutions() WorkflowClient.php : 349

Get count of workflow executions using List Filter Query syntax.

public countWorkflowExecutions(string $query[, string|null $namespace = null ]) : CountWorkflowExecutions

Query example:

WorkflowType='MyWorkflow' and StartTime between '2022-08-22T15:04:05+00:00' and '2023-08-22T15:04:05+00:00'
Parameters
$query : string
$namespace : string|null = null

If null, the preconfigured namespace will be used.

Return valuesCountWorkflowExecutions create() WorkflowClient.php : 94 public static create(ServiceClientInterface $serviceClient[, ClientOptions|null $options = null ][, DataConverterInterface|null $converter = null ][, PipelineProvider|null $interceptorProvider = null ]) : static Parameters
$serviceClient : ServiceClientInterface
$options : ClientOptions|null = null
$converter : DataConverterInterface|null = null
$interceptorProvider : PipelineProvider|null = null
Return valuesstatic getServiceClient() WorkflowClient.php : 103 public getServiceClient() : ServiceClientInterface Return valuesServiceClientInterface getWorkflowHistory() WorkflowClient.php : 364 public getWorkflowHistory(WorkflowExecution $execution[, string|null $namespace = null ][, bool $waitNewEvent = false ][, int $historyEventFilterType = HistoryEventFilterType::HISTORY_EVENT_FILTER_TYPE_ALL_EVENT ][, bool $skipArchival = false ][, int $pageSize = 0 ]) : WorkflowExecutionHistory Parameters
$execution : WorkflowExecution
$namespace : string|null = null

If null, the preconfigured namespace will be used.

$waitNewEvent : bool = false

If set to true, the RPC call will not resolve until there is a new event which matches, the $historyEventFilterType, or a timeout is hit. The RPC call will be resolved immediately if the workflow was already finished.

$historyEventFilterType : int = HistoryEventFilterType::HISTORY_EVENT_FILTER_TYPE_ALL_EVENT
$skipArchival : bool = false
$pageSize : int = 0

Size of the pages to be requested. It affects internal queries only. Use it if you want to load limited number of events from the history.

Return valuesWorkflowExecutionHistory listWorkflowExecutions() WorkflowClient.php : 314

Get paginated list of workflow executions using List Filter Query syntax.

public listWorkflowExecutions(string $query[, string|null $namespace = null ][, int $pageSize = 10 ]) : Paginator<string|int, WorkflowExecutionInfo>

Query example:

WorkflowType='MyWorkflow' and StartTime  between '2022-08-22T15:04:05+00:00' and  '2023-08-22T15:04:05+00:00'
Parameters
$query : string
$namespace : string|null = null

If null, the preconfigured namespace will be used.

$pageSize : int = 10

Maximum number of workflow info per page.

Return valuesPaginator<string|int, WorkflowExecutionInfo> newActivityCompletionClient() WorkflowClient.php : 309

Creates a new `ActivityCompletionClient` that can be used to complete activities asynchronously.

public newActivityCompletionClient() : ActivityCompletionClientInterface

Only relevant for activity implementations that called ActivityContext::doNotCompleteOnReturn().

Return valuesActivityCompletionClientInterface newRunningWorkflowStub() WorkflowClient.php : 281

Returns workflow stub associated with running workflow.

public newRunningWorkflowStub(string $class, string $workflowID[, string|null $runID = null ]) : T Parameters
$class : string
$workflowID : string
$runID : string|null = null
Return valuesT newUntypedRunningWorkflowStub() WorkflowClient.php : 292

Returns untyped workflow stub associated with running workflow.

public newUntypedRunningWorkflowStub(string $workflowID[, string|null $runID = null ][, string|null $workflowType = null ]) : WorkflowStubInterface Parameters
$workflowID : string
$runID : string|null = null
$workflowType : string|null = null
Return valuesWorkflowStubInterface newUntypedWorkflowStub() WorkflowClient.php : 265

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.

public newUntypedWorkflowStub(string $workflowType[, WorkflowOptions|null $options = null ]) : WorkflowStubInterface

Use WorkflowClient->start($workflowStub, ...$args) to start workflow asynchronously.

IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.

Parameters
$workflowType : string
$options : WorkflowOptions|null = null
Return valuesWorkflowStubInterface newWorkflowStub() WorkflowClient.php : 252

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

public newWorkflowStub(string $class[, WorkflowOptions|null $options = null ]) : T

The first call must be to a method annotated with WorkflowMethod. After workflow is started it can be also used to send signals or queries to it.

Use WorkflowClient->start($workflowStub, ...$args) to start workflow asynchronously.

IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.

Parameters
$class : string
$options : WorkflowOptions|null = null
Return valuesT signalWithStart() WorkflowClient.php : 150

Starts untyped and typed workflow stubs in async mode. Sends signal on start.

public signalWithStart(mixed $workflow, string $signal[, array<string|int, mixed> $signalArgs = [] ][, array<string|int, mixed> $startArgs = [] ]) : WorkflowRunInterface Parameters
$workflow : mixed
$signal : string
$signalArgs : array<string|int, mixed> = []
$startArgs : array<string|int, mixed> = []
Return valuesWorkflowRunInterface start() WorkflowClient.php : 108

Starts workflow in async mode.

public start(mixed $workflow, mixed ...$args) : WorkflowRunInterface

Returns WorkflowRun object which can be used to wait for the execution result. WorkflowRun objects created by typed workflow stubs will attempt to type the execution result as well.

Parameters
$workflow : mixed
$args : mixed
Return valuesWorkflowRunInterface startWithSignal() WorkflowClient.php : 208 public startWithSignal(mixed $workflow, string $signal[, array<string|int, mixed> $signalArgs = [] ][, array<string|int, mixed> $startArgs = [] ]) : WorkflowRunInterface Parameters
$workflow : mixed
$signal : string
$signalArgs : array<string|int, mixed> = []
$startArgs : array<string|int, mixed> = []
Return valuesWorkflowRunInterface updateWithStart() WorkflowClient.php : 218

Starts untyped and typed workflow stubs in async mode. Sends Update on start.

public updateWithStart(mixed $workflow, string|UpdateOptions $update[, array<string|int, mixed> $updateArgs = [] ][, array<string|int, mixed> $startArgs = [] ]) : UpdateHandle Parameters
$workflow : mixed
$update : string|UpdateOptions

Name of the update handler or update options.

$updateArgs : array<string|int, mixed> = []
$startArgs : array<string|int, mixed> = []
Return valuesUpdateHandle createReader() WorkflowClient.php : 409 private createReader() : ReaderInterface Return valuesReaderInterface getStarter() WorkflowClient.php : 418 private getStarter() : WorkflowStarter Return valuesWorkflowStarter

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4