Skip to main content

Class: WorkflowExecutionPauseInfo

WorkflowExecutionPauseInfo contains the information about a workflow execution pause.

Properties​

identity​

identity: string

The identity of the client who paused the workflow execution.

pausedTime?​

optional pausedTime?: $Properties | null

The time when the workflow execution was paused.

reason​

reason: string

The reason for pausing the workflow execution.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionPauseInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionPauseInfo & $Properties

Creates a new WorkflowExecutionPauseInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionPauseInfo & $Properties

WorkflowExecutionPauseInfo instance

Call Signature​

static create(properties?): WorkflowExecutionPauseInfo

Creates a new WorkflowExecutionPauseInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionPauseInfo

WorkflowExecutionPauseInfo instance

decode()​

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

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

WorkflowExecutionPauseInfo & $Properties

WorkflowExecutionPauseInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionPauseInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionPauseInfo & $Properties

WorkflowExecutionPauseInfo

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

Parameters​

message​

$Properties

WorkflowExecutionPauseInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionPauseInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionPauseInfo

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionPauseInfo

WorkflowExecutionPauseInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionPauseInfo

WorkflowExecutionPauseInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object