Skip to main content

Class: UnpauseActivityExecutionRequest

Represents an UnpauseActivityExecutionRequest.

Properties​

activityId​

activityId: string

The ID of the activity to target.


identity​

identity: string

The identity of the client who initiated this request.


jitter?​

optional jitter?: $Properties | null

If set, the activity will start at a random time within the specified jitter duration.


namespace​

namespace: string

Namespace of the workflow which scheduled this activity.


reason​

reason: string

Reason to unpause the activity.


requestId​

requestId: string

Used to de-dupe unpause 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, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.

Methods​

toJSON()​

toJSON(): object

Converts this UnpauseActivityExecutionRequest to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): UnpauseActivityExecutionRequest & $Properties

Creates a new UnpauseActivityExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnpauseActivityExecutionRequest & $Properties

UnpauseActivityExecutionRequest instance

Call Signature​

static create(properties?): UnpauseActivityExecutionRequest

Creates a new UnpauseActivityExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnpauseActivityExecutionRequest

UnpauseActivityExecutionRequest instance


decode()​

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

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

UnpauseActivityExecutionRequest & $Properties

UnpauseActivityExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): UnpauseActivityExecutionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UnpauseActivityExecutionRequest & $Properties

UnpauseActivityExecutionRequest

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

Parameters​

message​

$Properties

UnpauseActivityExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UnpauseActivityExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): UnpauseActivityExecutionRequest

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

Parameters​

object​

Plain object

Returns​

UnpauseActivityExecutionRequest

UnpauseActivityExecutionRequest


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UnpauseActivityExecutionRequest

UnpauseActivityExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object