Skip to main content

Class: WorkflowExecutionSignaledEventAttributes

history.v1.WorkflowExecutionSignaledEventAttributes

Represents a WorkflowExecutionSignaledEventAttributes.

Implements

Constructors

constructor

new WorkflowExecutionSignaledEventAttributes(properties?): WorkflowExecutionSignaledEventAttributes

Constructs a new WorkflowExecutionSignaledEventAttributes.

Parameters

NameTypeDescription
properties?IWorkflowExecutionSignaledEventAttributesProperties to set

Returns

WorkflowExecutionSignaledEventAttributes

Properties

externalWorkflowExecution

Optional externalWorkflowExecution: null | IWorkflowExecution

When signal origin is a workflow execution, this field is set.

Implementation of

IWorkflowExecutionSignaledEventAttributes.externalWorkflowExecution


Optional header: null | IHeader

Headers that were passed by the sender of the signal and copied by temporal server into the workflow task.

Implementation of

IWorkflowExecutionSignaledEventAttributes.header


identity

identity: string

id of the worker/client who sent this signal

Implementation of

IWorkflowExecutionSignaledEventAttributes.identity


input

Optional input: null | IPayloads

Will be deserialized and provided as argument(s) to the signal handler

Implementation of

IWorkflowExecutionSignaledEventAttributes.input


signalName

signalName: string

The name/type of the signal to fire

Implementation of

IWorkflowExecutionSignaledEventAttributes.signalName


skipGenerateWorkflowTask

skipGenerateWorkflowTask: boolean

Indicates the signal did not generate a new workflow task when received.

Implementation of

IWorkflowExecutionSignaledEventAttributes.skipGenerateWorkflowTask

Methods

toJSON

toJSON(): Object

Converts this WorkflowExecutionSignaledEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowExecutionSignaledEventAttributes

Creates a new WorkflowExecutionSignaledEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowExecutionSignaledEventAttributesProperties to set

Returns

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes instance


decode

decode(reader, length?): WorkflowExecutionSignaledEventAttributes

Decodes a WorkflowExecutionSignaledEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowExecutionSignaledEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes

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 WorkflowExecutionSignaledEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionSignaledEventAttributes.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): WorkflowExecutionSignaledEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionSignaledEventAttributes

Parameters

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

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageWorkflowExecutionSignaledEventAttributesWorkflowExecutionSignaledEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object