Skip to main content

Class: UnpauseActivityRequest

Deprecated. Use UnpauseActivityExecutionRequest.

Properties​

activity?​

optional activity?: "id" | "type" | "unpauseAll"

either activity id or activity type must be provided

execution?​

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

id?​

optional id?: string | null

Only the activity with this ID will be unpaused.

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.

resetAttempts​

resetAttempts: boolean

Providing this flag will also reset the number of attempts.

resetHeartbeat​

resetHeartbeat: boolean

Providing this flag will also reset the heartbeat details.

type?​

optional type?: string | null

Unpause all running activities with of this type.

unpauseAll?​

optional unpauseAll?: boolean | null

Unpause all running activities.

Methods​

toJSON()​

toJSON(): object

Converts this UnpauseActivityRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UnpauseActivityRequest & $Shape

Creates a new UnpauseActivityRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UnpauseActivityRequest & $Shape

UnpauseActivityRequest instance

Call Signature​

static create(properties?): UnpauseActivityRequest

Creates a new UnpauseActivityRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnpauseActivityRequest

UnpauseActivityRequest instance

decode()​

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

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

UnpauseActivityRequest & $Shape

UnpauseActivityRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UnpauseActivityRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UnpauseActivityRequest & $Shape

UnpauseActivityRequest

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

Parameters​

message​

$Properties

UnpauseActivityRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UnpauseActivityRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UnpauseActivityRequest

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

Parameters​

object​

Plain object

Returns​

UnpauseActivityRequest

UnpauseActivityRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UnpauseActivityRequest

UnpauseActivityRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object