WorkflowClientInterface
in
The application-facing workflow operations implemented by Client and its test fake.
Table of Contents
Methods
- appendWorkflowStream() : WorkflowStreamAppendResult
- closeWorkflowStream() : WorkflowStreamDescription
- describeWorkflowStream() : WorkflowStreamDescription
- iterateWorkflowStream() : Generator<int, WorkflowStreamItem>
- listWorkflowStreams() : array<int, WorkflowStreamDescription>
- startWorkflow() : WorkflowHandleInterface
- subscribeWorkflowStream() : WorkflowStreamPage
- workflowHandle() : WorkflowHandleInterface
Methods
appendWorkflowStream()
public
appendWorkflowStream(string $workflowId, string $runId, string $streamName, array<int, WorkflowStreamAppendItem> $items[, int|null $maxPendingItems = null ]) : WorkflowStreamAppendResult
Parameters
- $workflowId : string
- $runId : string
- $streamName : string
- $items : array<int, WorkflowStreamAppendItem>
- $maxPendingItems : int|null = null
Return values
WorkflowStreamAppendResultcloseWorkflowStream()
public
closeWorkflowStream(string $workflowId, string $runId, string $streamName[, string|null $errorReason = null ][, int|null $retentionSeconds = null ]) : WorkflowStreamDescription
Parameters
- $workflowId : string
- $runId : string
- $streamName : string
- $errorReason : string|null = null
- $retentionSeconds : int|null = null
Return values
WorkflowStreamDescriptiondescribeWorkflowStream()
public
describeWorkflowStream(string $workflowId, string $runId, string $streamName) : WorkflowStreamDescription
Parameters
- $workflowId : string
- $runId : string
- $streamName : string
Return values
WorkflowStreamDescriptioniterateWorkflowStream()
public
iterateWorkflowStream(string $workflowId, string $runId, string $streamName[, int $fromOffset = 0 ][, int $maxItems = 100 ][, int $waitSeconds = 30 ][, callable(): bool|null $cancelled = null ]) : Generator<int, WorkflowStreamItem>
Parameters
- $workflowId : string
- $runId : string
- $streamName : string
- $fromOffset : int = 0
- $maxItems : int = 100
- $waitSeconds : int = 30
- $cancelled : callable(): bool|null = null
Return values
Generator<int, WorkflowStreamItem>listWorkflowStreams()
public
listWorkflowStreams(string $workflowId, string $runId) : array<int, WorkflowStreamDescription>
Parameters
- $workflowId : string
- $runId : string
Return values
array<int, WorkflowStreamDescription>startWorkflow()
public
startWorkflow(string $workflowType, string $workflowId, string $taskQueue[, array<int, mixed> $input = [] ][, int $executionTimeoutSeconds = 3600 ][, int $runTimeoutSeconds = 600 ][, string|null $duplicatePolicy = null ][, array<string, mixed>|null $memo = null ][, array<string, mixed>|null $searchAttributes = null ][, int|null $priority = null ][, string|null $fairnessKey = null ][, int|null $fairnessWeight = null ][, string|null $buildId = null ]) : WorkflowHandleInterface
Parameters
- $workflowType : string
- $workflowId : string
- $taskQueue : string
- $input : array<int, mixed> = []
- $executionTimeoutSeconds : int = 3600
- $runTimeoutSeconds : int = 600
- $duplicatePolicy : string|null = null
- $memo : array<string, mixed>|null = null
- $searchAttributes : array<string, mixed>|null = null
- $priority : int|null = null
- $fairnessKey : string|null = null
- $fairnessWeight : int|null = null
- $buildId : string|null = null
Return values
WorkflowHandleInterfacesubscribeWorkflowStream()
public
subscribeWorkflowStream(string $workflowId, string $runId, string $streamName[, int $fromOffset = 0 ][, int $maxItems = 100 ][, int $waitSeconds = 0 ][, callable(): bool|null $cancelled = null ]) : WorkflowStreamPage
Parameters
- $workflowId : string
- $runId : string
- $streamName : string
- $fromOffset : int = 0
- $maxItems : int = 100
- $waitSeconds : int = 0
- $cancelled : callable(): bool|null = null
Return values
WorkflowStreamPageworkflowHandle()
public
workflowHandle(string $workflowId[, string|null $selectedRunId = null ]) : WorkflowHandleInterface
Parameters
- $workflowId : string
- $selectedRunId : string|null = null