Class: PauseActivityRequest

Deprecated. Use PauseActivityExecutionRequest.

Properties

activity?

optional activity?: "id" | "type"

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 paused.

---

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.

---

type?

optional type?: string | null

Pause all running activities of this type. Note: Experimental - the behavior of pause by activity type might change in a future release.

Methods

toJSON()

toJSON(): object

Converts this PauseActivityRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): PauseActivityRequest & $Shape

Creates a new PauseActivityRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

PauseActivityRequest & $Shape

PauseActivityRequest instance

Call Signature

static create(properties?): PauseActivityRequest

Creates a new PauseActivityRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PauseActivityRequest

PauseActivityRequest instance

---

decode()

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

Decodes a PauseActivityRequest 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

PauseActivityRequest & $Shape

PauseActivityRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): PauseActivityRequest & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

PauseActivityRequest & $Shape

PauseActivityRequest

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

Parameters

message

$Properties

PauseActivityRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

PauseActivityRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): PauseActivityRequest

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

Parameters

object

Plain object

Returns

PauseActivityRequest

PauseActivityRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

PauseActivityRequest

PauseActivityRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object