Skip to main content

Class: WorkflowExecution

common.v1.WorkflowExecution

Represents a WorkflowExecution.

Implements#

Constructors#

constructor#

new WorkflowExecution(properties?)

Constructs a new WorkflowExecution.

Parameters#

NameType
properties?IWorkflowExecution

Properties#

runId#

runId: string

WorkflowExecution runId.

Implementation of#

IWorkflowExecution.runId


workflowId#

workflowId: string

WorkflowExecution workflowId.

Implementation of#

IWorkflowExecution.workflowId

Methods#

toJSON#

toJSON(): Object

Converts this WorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WorkflowExecution

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

WorkflowExecution

WorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): WorkflowExecution

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

WorkflowExecution

WorkflowExecution


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WorkflowExecution

WorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWorkflowExecutionWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object