StartWorkflowAction
extends ScheduleAction
in package
uses
CloneWith
FinalYes
Start a new Workflow execution.
Tags
Table of Contents
Properties
- $header : HeaderInterface
- Header
- $input : ValuesInterface
- Argument list to the workflow
- $memo : EncodedCollection
- Memo
- $retryPolicy : RetryOptions
- The retry policy for the workflow. Will never exceed {@see self::$workflowExecutionTimeout}.
- $searchAttributes : EncodedCollection
- Search Attributes.
- $taskQueue : TaskQueue
- Task queue
- $workflowExecutionTimeout : DateInterval
- Total workflow execution timeout including retries and continue as new
- $workflowId : string
- Workflow ID
- $workflowIdReusePolicy : IdReusePolicy
- Default {@see IdReusePolicy::AllowDuplicate}
- $workflowRunTimeout : DateInterval
- Timeout of a single workflow run
- $workflowTaskTimeout : DateInterval
- Timeout of a single workflow task
- $workflowType : WorkflowType
- Workflow type
Methods
- new() : self
- withHeader() : self
- Header
- withInput() : self
- Arguments to the workflow
- withMemo() : self
- Memo
- withRetryPolicy() : self
- The retry policy for the workflow. Will never exceed {@see self::$workflowExecutionTimeout}
- withSearchAttributes() : self
- Search attributes
- withTaskQueue() : self
- withWorkflowExecutionTimeout() : self
- Total workflow execution timeout including retries and continue as new
- withWorkflowId() : self
- withWorkflowIdReusePolicy() : self
- withWorkflowRunTimeout() : self
- Timeout of a single workflow run
- withWorkflowTaskTimeout() : self
- Timeout of a single workflow task
- withWorkflowType() : self
- __construct() : mixed
- createWorkflowType() : WorkflowType
Properties
$header read-only
Header
public
HeaderInterface
$header
$input read-only
Argument list to the workflow
public
ValuesInterface
$input
$memo read-only
Memo
public
EncodedCollection
$memo
$retryPolicy read-only
The retry policy for the workflow. Will never exceed {@see self::$workflowExecutionTimeout}.
public
RetryOptions
$retryPolicy
$searchAttributes read-only
Search Attributes.
public
EncodedCollection
$searchAttributes
$taskQueue read-only
Task queue
public
TaskQueue
$taskQueue
$workflowExecutionTimeout read-only
Total workflow execution timeout including retries and continue as new
public
DateInterval
$workflowExecutionTimeout
$workflowId read-only
Workflow ID
public
string
$workflowId
$workflowIdReusePolicy read-only
Default {@see IdReusePolicy::AllowDuplicate}
public
IdReusePolicy
$workflowIdReusePolicy
$workflowRunTimeout read-only
Timeout of a single workflow run
public
DateInterval
$workflowRunTimeout
$workflowTaskTimeout read-only
Timeout of a single workflow task
public
DateInterval
$workflowTaskTimeout
$workflowType read-only
Workflow type
public
WorkflowType
$workflowType
Methods
new()
public
static new(string|WorkflowType $workflowType) : self
Parameters
- $workflowType : string|WorkflowType
Return values
selfwithHeader()
Header
public
withHeader(iterable<non-empty-string, mixed>|HeaderInterface $values) : self
Parameters
- $values : iterable<non-empty-string, mixed>|HeaderInterface
Return values
selfwithInput()
Arguments to the workflow
public
withInput(array<int, mixed>|ValuesInterface $values) : self
Parameters
- $values : array<int, mixed>|ValuesInterface
Return values
selfwithMemo()
Memo
public
withMemo(iterable<non-empty-string, mixed>|EncodedCollection $values) : self
Parameters
- $values : iterable<non-empty-string, mixed>|EncodedCollection
Return values
selfwithRetryPolicy()
The retry policy for the workflow. Will never exceed {@see self::$workflowExecutionTimeout}
public
withRetryPolicy(RetryOptions $retryPolicy) : self
Parameters
- $retryPolicy : RetryOptions
Return values
selfwithSearchAttributes()
Search attributes
public
withSearchAttributes(iterable<non-empty-string, mixed>|EncodedCollection $values) : self
Parameters
- $values : iterable<non-empty-string, mixed>|EncodedCollection
Return values
selfwithTaskQueue()
public
withTaskQueue(string|TaskQueue $taskQueue) : self
Parameters
- $taskQueue : string|TaskQueue
Return values
selfwithWorkflowExecutionTimeout()
Total workflow execution timeout including retries and continue as new
public
withWorkflowExecutionTimeout(DateIntervalValue $timeout) : self
Parameters
- $timeout : DateIntervalValue
Return values
selfwithWorkflowId()
public
withWorkflowId(string $workflowId) : self
Parameters
- $workflowId : string
Return values
selfwithWorkflowIdReusePolicy()
public
withWorkflowIdReusePolicy(IdReusePolicy $policy) : self
Parameters
- $policy : IdReusePolicy
Return values
selfwithWorkflowRunTimeout()
Timeout of a single workflow run
public
withWorkflowRunTimeout(DateIntervalValue $timeout) : self
Parameters
- $timeout : DateIntervalValue
Return values
selfwithWorkflowTaskTimeout()
Timeout of a single workflow task
public
withWorkflowTaskTimeout(DateIntervalValue $timeout) : self
Parameters
- $timeout : DateIntervalValue
Return values
selfwithWorkflowType()
public
withWorkflowType(string|WorkflowType $workflowType) : self
Parameters
- $workflowType : string|WorkflowType
Return values
self__construct()
private
__construct(WorkflowType $workflowType) : mixed
Parameters
- $workflowType : WorkflowType
createWorkflowType()
private
static createWorkflowType(string $name) : WorkflowType
Parameters
- $name : string