Skip to main content

Class: WorkflowExecution

common.v1.WorkflowExecution

Represents a WorkflowExecution.

Implements

Constructors

constructor

new WorkflowExecution(properties?)

Constructs a new WorkflowExecution.

Parameters

NameTypeDescription
properties?IWorkflowExecutionProperties to set

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


create

Static create(properties?): WorkflowExecution

Creates a new WorkflowExecution instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowExecutionProperties to set

Returns

WorkflowExecution

WorkflowExecution instance


decode

Static decode(reader, length?): WorkflowExecution

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

WorkflowExecution

WorkflowExecution


decodeDelimited

Static decodeDelimited(reader): WorkflowExecution

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

WorkflowExecution

WorkflowExecution


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecution

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 WorkflowExecution message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageWorkflowExecutionWorkflowExecution
options?IConversionOptionsConversion options

Returns

Object

Plain object