Skip to main content

Class: SignalWorkflowExecutionRequest

workflowservice.v1.SignalWorkflowExecutionRequest

Represents a SignalWorkflowExecutionRequest.

Implements#

Constructors#

constructor#

new SignalWorkflowExecutionRequest(properties?)

Constructs a new SignalWorkflowExecutionRequest.

Parameters#

NameType
properties?ISignalWorkflowExecutionRequest

Properties#

control#

control: string

SignalWorkflowExecutionRequest control.

Implementation of#

ISignalWorkflowExecutionRequest.control


identity#

identity: string

SignalWorkflowExecutionRequest identity.

Implementation of#

ISignalWorkflowExecutionRequest.identity


input#

Optional input: null | IPayloads

SignalWorkflowExecutionRequest input.

Implementation of#

ISignalWorkflowExecutionRequest.input


namespace#

namespace: string

SignalWorkflowExecutionRequest namespace.

Implementation of#

ISignalWorkflowExecutionRequest.namespace


requestId#

requestId: string

SignalWorkflowExecutionRequest requestId.

Implementation of#

ISignalWorkflowExecutionRequest.requestId


signalName#

signalName: string

SignalWorkflowExecutionRequest signalName.

Implementation of#

ISignalWorkflowExecutionRequest.signalName


workflowExecution#

Optional workflowExecution: null | IWorkflowExecution

SignalWorkflowExecutionRequest workflowExecution.

Implementation of#

ISignalWorkflowExecutionRequest.workflowExecution

Methods#

toJSON#

toJSON(): Object

Converts this SignalWorkflowExecutionRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): SignalWorkflowExecutionRequest

Decodes a SignalWorkflowExecutionRequest 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#

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest


decodeDelimited#

Static decodeDelimited(reader): SignalWorkflowExecutionRequest

Decodes a SignalWorkflowExecutionRequest 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#

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): SignalWorkflowExecutionRequest

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageSignalWorkflowExecutionRequestSignalWorkflowExecutionRequest
options?IConversionOptions-

Returns#

Object

Plain object