Skip to main content

Class: UnpauseWorkflowExecutionRequest

Represents an UnpauseWorkflowExecutionRequest.

Properties​

identity​

identity: string

The identity of the client who initiated this request.

namespace​

namespace: string

Namespace of the workflow to unpause.

reason​

reason: string

Reason to unpause the workflow execution.

requestId​

requestId: string

A unique identifier for this unpause request for idempotence. Typically UUIDv4.

runId​

runId: string

Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.

workflowId​

workflowId: string

ID of the workflow execution to be paused. Required.

Methods​

toJSON()​

toJSON(): object

Converts this UnpauseWorkflowExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UnpauseWorkflowExecutionRequest & $Properties

Creates a new UnpauseWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnpauseWorkflowExecutionRequest & $Properties

UnpauseWorkflowExecutionRequest instance

Call Signature​

static create(properties?): UnpauseWorkflowExecutionRequest

Creates a new UnpauseWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnpauseWorkflowExecutionRequest

UnpauseWorkflowExecutionRequest instance

decode()​

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

Decodes an UnpauseWorkflowExecutionRequest 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​

UnpauseWorkflowExecutionRequest & $Properties

UnpauseWorkflowExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UnpauseWorkflowExecutionRequest & $Properties

Decodes an UnpauseWorkflowExecutionRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UnpauseWorkflowExecutionRequest & $Properties

UnpauseWorkflowExecutionRequest

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

Parameters​

message​

$Properties

UnpauseWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UnpauseWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UnpauseWorkflowExecutionRequest

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

Parameters​

object​

Plain object

Returns​

UnpauseWorkflowExecutionRequest

UnpauseWorkflowExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UnpauseWorkflowExecutionRequest

UnpauseWorkflowExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object