Skip to main content

Class: NamespacedWorkflowExecution

coresdk.common.NamespacedWorkflowExecution

Identifying information about a particular workflow execution, including namespace

Implements​

Constructors​

constructor​

β€’ new NamespacedWorkflowExecution(properties?): NamespacedWorkflowExecution

Constructs a new NamespacedWorkflowExecution.

Parameters​

NameTypeDescription
properties?INamespacedWorkflowExecutionProperties to set

Returns​

NamespacedWorkflowExecution

Properties​

namespace​

β€’ namespace: string

Namespace the workflow run is located in

Implementation of​

INamespacedWorkflowExecution.namespace


runId​

β€’ runId: string

May be empty if the most recent run of the workflow with the given ID is being targeted

Implementation of​

INamespacedWorkflowExecution.runId


workflowId​

β€’ workflowId: string

Can never be empty

Implementation of​

INamespacedWorkflowExecution.workflowId

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this NamespacedWorkflowExecution to JSON.

Returns​

Object

JSON object


create​

β–Έ create(properties?): NamespacedWorkflowExecution

Creates a new NamespacedWorkflowExecution instance using the specified properties.

Parameters​

NameTypeDescription
properties?INamespacedWorkflowExecutionProperties to set

Returns​

NamespacedWorkflowExecution

NamespacedWorkflowExecution instance


decode​

β–Έ decode(reader, length?): NamespacedWorkflowExecution

Decodes a NamespacedWorkflowExecution message from the specified reader or buffer.

Parameters​

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

Returns​

NamespacedWorkflowExecution

NamespacedWorkflowExecution

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

β–Έ decodeDelimited(reader): NamespacedWorkflowExecution

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

NamespacedWorkflowExecution

NamespacedWorkflowExecution

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 NamespacedWorkflowExecution message. Does not implicitly coresdk.common.NamespacedWorkflowExecution.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

β–Έ encodeDelimited(message, writer?): Writer

Encodes the specified NamespacedWorkflowExecution message, length delimited. Does not implicitly coresdk.common.NamespacedWorkflowExecution.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


fromObject​

β–Έ fromObject(object): NamespacedWorkflowExecution

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

NamespacedWorkflowExecution

NamespacedWorkflowExecution


getTypeUrl​

β–Έ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NamespacedWorkflowExecution

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

Parameters​

NameTypeDescription
messageNamespacedWorkflowExecutionNamespacedWorkflowExecution
options?IConversionOptionsConversion options

Returns​

Object

Plain object