Skip to main content

Class: SignalWorkflowExecutionRequest

workflowservice.v1.SignalWorkflowExecutionRequest

Represents a SignalWorkflowExecutionRequest.

Implements

Constructors

constructor

new SignalWorkflowExecutionRequest(properties?)

Constructs a new SignalWorkflowExecutionRequest.

Parameters

NameTypeDescription
properties?ISignalWorkflowExecutionRequestProperties to set

Properties

control

control: string

SignalWorkflowExecutionRequest control.

Implementation of

ISignalWorkflowExecutionRequest.control


Optional header: null | IHeader

SignalWorkflowExecutionRequest header.

Implementation of

ISignalWorkflowExecutionRequest.header


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


create

Static create(properties?): SignalWorkflowExecutionRequest

Creates a new SignalWorkflowExecutionRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?ISignalWorkflowExecutionRequestProperties to set

Returns

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest instance


decode

Static decode(reader, length?): SignalWorkflowExecutionRequest

Decodes a SignalWorkflowExecutionRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest


decodeDelimited

Static decodeDelimited(reader): SignalWorkflowExecutionRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

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 temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.verify|verify messages.

Parameters

NameTypeDescription
messageISignalWorkflowExecutionRequestSignalWorkflowExecutionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageISignalWorkflowExecutionRequestSignalWorkflowExecutionRequest message or plain object to encode
writer?WriterWriter to encode to

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for SignalWorkflowExecutionRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object