Skip to main content

Class: SignalExternalWorkflowExecutionCommandAttributes

command.v1.SignalExternalWorkflowExecutionCommandAttributes

Represents a SignalExternalWorkflowExecutionCommandAttributes.

Implements#

Constructors#

constructor#

new SignalExternalWorkflowExecutionCommandAttributes(properties?)

Constructs a new SignalExternalWorkflowExecutionCommandAttributes.

Parameters#

NameType
properties?ISignalExternalWorkflowExecutionCommandAttributes

Properties#

childWorkflowOnly#

childWorkflowOnly: boolean

SignalExternalWorkflowExecutionCommandAttributes childWorkflowOnly.

Implementation of#

ISignalExternalWorkflowExecutionCommandAttributes.childWorkflowOnly


control#

control: string

SignalExternalWorkflowExecutionCommandAttributes control.

Implementation of#

ISignalExternalWorkflowExecutionCommandAttributes.control


execution#

Optional execution: null | IWorkflowExecution

SignalExternalWorkflowExecutionCommandAttributes execution.

Implementation of#

ISignalExternalWorkflowExecutionCommandAttributes.execution


input#

Optional input: null | IPayloads

SignalExternalWorkflowExecutionCommandAttributes input.

Implementation of#

ISignalExternalWorkflowExecutionCommandAttributes.input


namespace#

namespace: string

SignalExternalWorkflowExecutionCommandAttributes namespace.

Implementation of#

ISignalExternalWorkflowExecutionCommandAttributes.namespace


signalName#

signalName: string

SignalExternalWorkflowExecutionCommandAttributes signalName.

Implementation of#

ISignalExternalWorkflowExecutionCommandAttributes.signalName

Methods#

toJSON#

toJSON(): Object

Converts this SignalExternalWorkflowExecutionCommandAttributes to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): SignalExternalWorkflowExecutionCommandAttributes

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

SignalExternalWorkflowExecutionCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes


decodeDelimited#

Static decodeDelimited(reader): SignalExternalWorkflowExecutionCommandAttributes

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

SignalExternalWorkflowExecutionCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): SignalExternalWorkflowExecutionCommandAttributes

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

SignalExternalWorkflowExecutionCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageSignalExternalWorkflowExecutionCommandAttributesSignalExternalWorkflowExecutionCommandAttributes
options?IConversionOptions-

Returns#

Object

Plain object