Skip to main content

Class: PauseActivityExecutionRequest

Represents a PauseActivityExecutionRequest.

Properties​

activityId​

activityId: string

The ID of the activity to target.

identity​

identity: string

The identity of the client who initiated this request.

namespace​

namespace: string

Namespace of the workflow which scheduled this activity.

reason​

reason: string

Reason to pause the activity.

requestId​

requestId: string

Used to de-dupe pause requests.

resourceId​

resourceId: string

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

runId​

runId: string

Run ID of the workflow or standalone activity. If empty, targets the latest run.

workflowId​

workflowId: string

If provided, pause a workflow activity (or activities) for the given workflow ID. If empty, targets a standalone activity.

Methods​

toJSON()​

toJSON(): object

Converts this PauseActivityExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PauseActivityExecutionRequest & $Properties

Creates a new PauseActivityExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PauseActivityExecutionRequest & $Properties

PauseActivityExecutionRequest instance

Call Signature​

static create(properties?): PauseActivityExecutionRequest

Creates a new PauseActivityExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PauseActivityExecutionRequest

PauseActivityExecutionRequest instance

decode()​

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

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

PauseActivityExecutionRequest & $Properties

PauseActivityExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PauseActivityExecutionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PauseActivityExecutionRequest & $Properties

PauseActivityExecutionRequest

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

Parameters​

message​

$Properties

PauseActivityExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PauseActivityExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PauseActivityExecutionRequest

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

Parameters​

object​

Plain object

Returns​

PauseActivityExecutionRequest

PauseActivityExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PauseActivityExecutionRequest

PauseActivityExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object