Skip to main content

Class: NamespacedWorkflowExecution

Identifying information about a particular workflow execution, including namespace

Properties​

namespace​

namespace: string

Namespace the workflow run is located in

runId​

runId: string

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

workflowId​

workflowId: string

Can never be empty

Methods​

toJSON()​

toJSON(): object

Converts this NamespacedWorkflowExecution to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NamespacedWorkflowExecution & $Properties

Creates a new NamespacedWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespacedWorkflowExecution & $Properties

NamespacedWorkflowExecution instance

Call Signature​

static create(properties?): NamespacedWorkflowExecution

Creates a new NamespacedWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespacedWorkflowExecution

NamespacedWorkflowExecution instance

decode()​

static decode(reader, length?): NamespacedWorkflowExecution & $Properties

Decodes a NamespacedWorkflowExecution message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

NamespacedWorkflowExecution & $Properties

NamespacedWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NamespacedWorkflowExecution & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NamespacedWorkflowExecution & $Properties

NamespacedWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

NamespacedWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NamespacedWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NamespacedWorkflowExecution

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

NamespacedWorkflowExecution

NamespacedWorkflowExecution

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NamespacedWorkflowExecution

NamespacedWorkflowExecution

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object