Skip to main content

Class: SignalWithStartWorkflowExecutionRequest

workflowservice.v1.SignalWithStartWorkflowExecutionRequest

Represents a SignalWithStartWorkflowExecutionRequest.

Implements#

Constructors#

constructor#

new SignalWithStartWorkflowExecutionRequest(properties?)

Constructs a new SignalWithStartWorkflowExecutionRequest.

Parameters#

NameType
properties?ISignalWithStartWorkflowExecutionRequest

Properties#

control#

control: string

SignalWithStartWorkflowExecutionRequest control.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.control


cronSchedule#

cronSchedule: string

SignalWithStartWorkflowExecutionRequest cronSchedule.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.cronSchedule


header#

Optional header: null | IHeader

SignalWithStartWorkflowExecutionRequest header.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.header


identity#

identity: string

SignalWithStartWorkflowExecutionRequest identity.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.identity


input#

Optional input: null | IPayloads

SignalWithStartWorkflowExecutionRequest input.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.input


memo#

Optional memo: null | IMemo

SignalWithStartWorkflowExecutionRequest memo.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.memo


namespace#

namespace: string

SignalWithStartWorkflowExecutionRequest namespace.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.namespace


requestId#

requestId: string

SignalWithStartWorkflowExecutionRequest requestId.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.requestId


retryPolicy#

Optional retryPolicy: null | IRetryPolicy

SignalWithStartWorkflowExecutionRequest retryPolicy.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.retryPolicy


searchAttributes#

Optional searchAttributes: null | ISearchAttributes

SignalWithStartWorkflowExecutionRequest searchAttributes.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.searchAttributes


signalInput#

Optional signalInput: null | IPayloads

SignalWithStartWorkflowExecutionRequest signalInput.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.signalInput


signalName#

signalName: string

SignalWithStartWorkflowExecutionRequest signalName.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.signalName


taskQueue#

Optional taskQueue: null | ITaskQueue

SignalWithStartWorkflowExecutionRequest taskQueue.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.taskQueue


workflowExecutionTimeout#

Optional workflowExecutionTimeout: null | IDuration

SignalWithStartWorkflowExecutionRequest workflowExecutionTimeout.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.workflowExecutionTimeout


workflowId#

workflowId: string

SignalWithStartWorkflowExecutionRequest workflowId.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.workflowId


workflowIdReusePolicy#

workflowIdReusePolicy: WorkflowIdReusePolicy

SignalWithStartWorkflowExecutionRequest workflowIdReusePolicy.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.workflowIdReusePolicy


workflowRunTimeout#

Optional workflowRunTimeout: null | IDuration

SignalWithStartWorkflowExecutionRequest workflowRunTimeout.

Implementation of#

ISignalWithStartWorkflowExecutionRequest.workflowRunTimeout


workflowTaskTimeout#

Optional workflowTaskTimeout: null | IDuration

SignalWithStartWorkflowExecutionRequest workflowTaskTimeout.

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


decode#

Static decode(reader, length?): SignalWithStartWorkflowExecutionRequest

Decodes a SignalWithStartWorkflowExecutionRequest message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

SignalWithStartWorkflowExecutionRequest

SignalWithStartWorkflowExecutionRequest


decodeDelimited#

Static decodeDelimited(reader): SignalWithStartWorkflowExecutionRequest

Decodes a SignalWithStartWorkflowExecutionRequest message from the specified reader or buffer, length delimited.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

SignalWithStartWorkflowExecutionRequest

SignalWithStartWorkflowExecutionRequest


encode#

Static encode(message, writer?): Writer

Encodes the specified SignalWithStartWorkflowExecutionRequest message. Does not implicitly {@link temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest.verify|verify} messages.

Parameters#

NameTypeDescription
messageISignalWithStartWorkflowExecutionRequestSignalWithStartWorkflowExecutionRequest message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified SignalWithStartWorkflowExecutionRequest message, length delimited. Does not implicitly {@link temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest.verify|verify} messages.

Parameters#

NameTypeDescription
messageISignalWithStartWorkflowExecutionRequestSignalWithStartWorkflowExecutionRequest message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): SignalWithStartWorkflowExecutionRequest

Creates a SignalWithStartWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

SignalWithStartWorkflowExecutionRequest

SignalWithStartWorkflowExecutionRequest


toObject#

Static toObject(message, options?): Object

Creates a plain object from a SignalWithStartWorkflowExecutionRequest message. Also converts values to other types if specified.

Parameters#

NameTypeDescription
messageSignalWithStartWorkflowExecutionRequestSignalWithStartWorkflowExecutionRequest
options?IConversionOptions-

Returns#

Object

Plain object