Class: SignalWithStartWorkflowExecutionRequest
workflowservice.v1.SignalWithStartWorkflowExecutionRequest
Represents a SignalWithStartWorkflowExecutionRequest.
Implements
Constructors
constructor
• new SignalWithStartWorkflowExecutionRequest(properties?
): SignalWithStartWorkflowExecutionRequest
Constructs a new SignalWithStartWorkflowExecutionRequest.
Parameters
Name | Type | Description |
---|---|---|
properties? | ISignalWithStartWorkflowExecutionRequest | Properties to set |
Returns
SignalWithStartWorkflowExecutionRequest
Properties
control
• control: string
Deprecated
Implementation of
ISignalWithStartWorkflowExecutionRequest.control
cronSchedule
• cronSchedule: string
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
Implementation of
ISignalWithStartWorkflowExecutionRequest.cronSchedule
header
• Optional
header: null
| IHeader
SignalWithStartWorkflowExecutionRequest header.
Implementation of
ISignalWithStartWorkflowExecutionRequest.header
identity
• identity: string
The identity of the worker/client
Implementation of
ISignalWithStartWorkflowExecutionRequest.identity
input
• Optional
input: null
| IPayloads
Serialized arguments to the workflow. These are passed as arguments to the workflow function.
Implementation of
ISignalWithStartWorkflowExecutionRequest.input
links
• links: ILink
[]
Links to be associated with the WorkflowExecutionStarted and WorkflowExecutionSignaled events.
Implementation of
ISignalWithStartWorkflowExecutionRequest.links
memo
• Optional
memo: null
| IMemo
SignalWithStartWorkflowExecutionRequest memo.
Implementation of
ISignalWithStartWorkflowExecutionRequest.memo
namespace
• namespace: string
SignalWithStartWorkflowExecutionRequest namespace.
Implementation of
ISignalWithStartWorkflowExecutionRequest.namespace
priority
• Optional
priority: null
| IPriority
Priority metadata
Implementation of
ISignalWithStartWorkflowExecutionRequest.priority
requestId
• requestId: string
Used to de-dupe signal w/ start requests
Implementation of
ISignalWithStartWorkflowExecutionRequest.requestId
retryPolicy
• Optional
retryPolicy: null
| IRetryPolicy
Retry policy for the workflow
Implementation of
ISignalWithStartWorkflowExecutionRequest.retryPolicy
searchAttributes
• Optional
searchAttributes: null
| ISearchAttributes
SignalWithStartWorkflowExecutionRequest searchAttributes.
Implementation of
ISignalWithStartWorkflowExecutionRequest.searchAttributes
signalInput
• Optional
signalInput: null
| IPayloads
Serialized value(s) to provide with the signal
Implementation of
ISignalWithStartWorkflowExecutionRequest.signalInput
signalName
• signalName: string
The workflow author-defined name of the signal to send to the workflow
Implementation of
ISignalWithStartWorkflowExecutionRequest.signalName
taskQueue
• Optional
taskQueue: null
| ITaskQueue
The task queue to start this workflow on, if it will be started
Implementation of
ISignalWithStartWorkflowExecutionRequest.taskQueue
userMetadata
• Optional
userMetadata: null
| IUserMetadata
Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo for use by user interfaces to display the fixed as-of-start summary and details of the workflow.
Implementation of
ISignalWithStartWorkflowExecutionRequest.userMetadata
versioningOverride
• Optional
versioningOverride: null
| IVersioningOverride
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
Implementation of
ISignalWithStartWorkflowExecutionRequest.versioningOverride
workflowExecutionTimeout
• Optional
workflowExecutionTimeout: null
| IDuration
Total workflow execution timeout including retries and continue as new
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowExecutionTimeout
workflowId
• workflowId: string
SignalWithStartWorkflowExecutionRequest workflowId.
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowId
workflowIdConflictPolicy
• workflowIdConflictPolicy: WorkflowIdConflictPolicy
Defines how to resolve a workflow id conflict with a running workflow. The default policy is WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING. Note that WORKFLOW_ID_CONFLICT_POLICY_FAIL is an invalid option.
See workflow_id_reuse_policy
for handling a workflow id duplication with a closed workflow.
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowIdConflictPolicy
workflowIdReusePolicy
• workflowIdReusePolicy: WorkflowIdReusePolicy
Defines whether to allow re-using the workflow id from a previously closed workflow. The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
See workflow_id_reuse_policy
for handling a workflow id duplication with a running workflow.
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowIdReusePolicy
workflowRunTimeout
• Optional
workflowRunTimeout: null
| IDuration
Timeout of a single workflow run
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowRunTimeout
workflowStartDelay
• Optional
workflowStartDelay: null
| IDuration
Time to wait before dispatching the first workflow task. Cannot be used with cron_schedule
.
Note that the signal will be delivered with the first workflow task. If the workflow gets
another SignalWithStartWorkflow before the delay a workflow task will be dispatched immediately
and the rest of the delay period will be ignored, even if that request also had a delay.
Signal via SignalWorkflowExecution will not unblock the workflow.
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowStartDelay
workflowTaskTimeout
• Optional
workflowTaskTimeout: null
| IDuration
Timeout of a single workflow task
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowTaskTimeout
workflowType
• Optional
workflowType: null
| IWorkflowType
SignalWithStartWorkflowExecutionRequest workflowType.
Implementation of
ISignalWithStartWorkflowExecutionRequest.workflowType
Methods
toJSON
▸ toJSON(): Object
Converts this SignalWithStartWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): SignalWithStartWorkflowExecutionRequest
Creates a new SignalWithStartWorkflowExecutionRequest instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | ISignalWithStartWorkflowExecutionRequest | Properties to set |
Returns
SignalWithStartWorkflowExecutionRequest
SignalWithStartWorkflowExecutionRequest instance
decode
▸ decode(reader
, length?
): SignalWithStartWorkflowExecutionRequest
Decodes a SignalWithStartWorkflowExecutionRequest message from the specified reader or buffer.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
SignalWithStartWorkflowExecutionRequest
SignalWithStartWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): SignalWithStartWorkflowExecutionRequest
Decodes a SignalWithStartWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalWithStartWorkflowExecutionRequest
SignalWithStartWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message
, writer?
): Writer
Encodes the specified SignalWithStartWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | ISignalWithStartWorkflowExecutionRequest | SignalWithStartWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified SignalWithStartWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | ISignalWithStartWorkflowExecutionRequest | SignalWithStartWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): SignalWithStartWorkflowExecutionRequest
Creates a SignalWithStartWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
SignalWithStartWorkflowExecutionRequest
SignalWithStartWorkflowExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for SignalWithStartWorkflowExecutionRequest
Parameters
Name | Type | Description |
---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message
, options?
): Object
Creates a plain object from a SignalWithStartWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | SignalWithStartWorkflowExecutionRequest | SignalWithStartWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object