Class: PauseActivityExecutionRequest

workflowservice.v1.PauseActivityExecutionRequest

Represents a PauseActivityExecutionRequest.

Implements

• IPauseActivityExecutionRequest

Constructors

constructor

• new PauseActivityExecutionRequest(properties?): PauseActivityExecutionRequest

Constructs a new PauseActivityExecutionRequest.

Parameters

Name	Type	Description
properties?	IPauseActivityExecutionRequest	Properties to set

Returns

PauseActivityExecutionRequest

Properties

activityId

• activityId: string

The ID of the activity to target.

Implementation of

IPauseActivityExecutionRequest.activityId

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IPauseActivityExecutionRequest.identity

---

namespace

• namespace: string

Namespace of the workflow which scheduled this activity.

Implementation of

IPauseActivityExecutionRequest.namespace

---

reason

• reason: string

Reason to pause the activity.

Implementation of

IPauseActivityExecutionRequest.reason

---

requestId

• requestId: string

Used to de-dupe pause requests.

Implementation of

IPauseActivityExecutionRequest.requestId

---

resourceId

• resourceId: string

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

Implementation of

IPauseActivityExecutionRequest.resourceId

---

runId

• runId: string

Run ID of the workflow or standalone activity.

Implementation of

IPauseActivityExecutionRequest.runId

---

workflowId

• workflowId: string

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

Implementation of

IPauseActivityExecutionRequest.workflowId

Methods

toJSON

▸ toJSON(): Object

Converts this PauseActivityExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PauseActivityExecutionRequest

Creates a new PauseActivityExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPauseActivityExecutionRequest	Properties to set

Returns

PauseActivityExecutionRequest

PauseActivityExecutionRequest instance

---

decode

▸ decode(reader, length?): PauseActivityExecutionRequest

Decodes a PauseActivityExecutionRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

PauseActivityExecutionRequest

PauseActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PauseActivityExecutionRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

PauseActivityExecutionRequest

PauseActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPauseActivityExecutionRequest	PauseActivityExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPauseActivityExecutionRequest	PauseActivityExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PauseActivityExecutionRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PauseActivityExecutionRequest

PauseActivityExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PauseActivityExecutionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	PauseActivityExecutionRequest	PauseActivityExecutionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object