Documentation

StartWorkflowAction extends ScheduleAction
in package
uses CloneWith

FinalYes

Start a new Workflow execution.

Tags
psalm-import-type

DateIntervalValue from DateInterval

see
NewWorkflowExecutionInfo

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
withStaticDetails()  : self
General fixed details for this workflow execution that will appear in UI/CLI.
withStaticSummary()  : self
Single-line fixed summary for this workflow execution that will appear in UI/CLI.
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

$retryPolicy read-only

The retry policy for the workflow. Will never exceed {@see self::$workflowExecutionTimeout}.

public RetryOptions $retryPolicy

$workflowExecutionTimeout read-only

Total workflow execution timeout including retries and continue as new

public DateInterval $workflowExecutionTimeout

$workflowRunTimeout read-only

Timeout of a single workflow run

public DateInterval $workflowRunTimeout

$workflowTaskTimeout read-only

Timeout of a single workflow task

public DateInterval $workflowTaskTimeout

Methods

withRetryPolicy()

The retry policy for the workflow. Will never exceed {@see self::$workflowExecutionTimeout}

public withRetryPolicy(RetryOptions $retryPolicy) : self
Parameters
$retryPolicy : RetryOptions
Return values
self

withStaticDetails()

General fixed details for this workflow execution that will appear in UI/CLI.

public withStaticDetails(string $details) : self

This can be in Temporal Markdown format and can span multiple lines. This is a fixed value on the workflow that cannot be updated.

Parameters
$details : string
Tags
experimental

This feature is not stable and may change in the future.

Return values
self

withStaticSummary()

Single-line fixed summary for this workflow execution that will appear in UI/CLI.

public withStaticSummary(string $summary) : self

This can be in single-line Temporal Markdown format.

Parameters
$summary : string
Tags
experimental

This feature is not stable and may change in the future.

Return values
self

withWorkflowExecutionTimeout()

Total workflow execution timeout including retries and continue as new

public withWorkflowExecutionTimeout(DateIntervalValue $timeout) : self
Parameters
$timeout : DateIntervalValue
Return values
self

withWorkflowId()

public withWorkflowId(string $workflowId) : self
Parameters
$workflowId : string
Return values
self

withWorkflowRunTimeout()

Timeout of a single workflow run

public withWorkflowRunTimeout(DateIntervalValue $timeout) : self
Parameters
$timeout : DateIntervalValue
Return values
self

withWorkflowTaskTimeout()

Timeout of a single workflow task

public withWorkflowTaskTimeout(DateIntervalValue $timeout) : self
Parameters
$timeout : DateIntervalValue
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results