Skip to main content

Class: PauseInfo

Represents a PauseInfo.

Properties​

manual?​

optional manual?: $Properties | null

activity was paused by the manual intervention

pausedBy?​

optional pausedBy?: "manual" | "rule"

PauseInfo pausedBy.

pauseTime?​

optional pauseTime?: $Properties | null

The time when the activity was paused.

rule?​

optional rule?: $Properties | null

activity was paused by the rule

Methods​

toJSON()​

toJSON(): object

Converts this PauseInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PauseInfo & $Shape

Creates a new PauseInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

PauseInfo & $Shape

PauseInfo instance

Call Signature​

static create(properties?): PauseInfo

Creates a new PauseInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PauseInfo

PauseInfo instance

decode()​

static decode(reader, length?): PauseInfo & $Shape

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

PauseInfo & $Shape

PauseInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PauseInfo & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PauseInfo & $Shape

PauseInfo

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

Parameters​

message​

$Properties

PauseInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PauseInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PauseInfo

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

Parameters​

object​

Plain object

Returns​

PauseInfo

PauseInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PauseInfo

PauseInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object