Skip to main content

Class: WorkflowMetadata

The name of the query to retrieve this information is __temporal_workflow_metadata.

Properties​

currentDetails​

currentDetails: string

Current long-form details of the workflow's state. This is used by user interfaces to show long-form text. This text may be formatted by the user interface.

definition?​

optional definition?: $Properties | null

Metadata provided at declaration or creation time.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowMetadata to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowMetadata & $Properties

Creates a new WorkflowMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowMetadata & $Properties

WorkflowMetadata instance

Call Signature​

static create(properties?): WorkflowMetadata

Creates a new WorkflowMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowMetadata

WorkflowMetadata instance

decode()​

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

Decodes a WorkflowMetadata 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​

WorkflowMetadata & $Properties

WorkflowMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowMetadata & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowMetadata & $Properties

WorkflowMetadata

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

Parameters​

message​

$Properties

WorkflowMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowMetadata

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

Parameters​

object​

Plain object

Returns​

WorkflowMetadata

WorkflowMetadata

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowMetadata

WorkflowMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object