Class: PauseActivityRequest
workflowservice.v1.PauseActivityRequest
Deprecated. Use PauseActivityExecutionRequest.
Properties
activity
• Optional activity: "id" | "type"
either activity id or activity type must be provided
execution
• Optional execution: null | $Properties
Execution info of the workflow which scheduled this activity
id
• Optional id: null | string
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: null | string
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
▸ create(properties?): PauseActivityRequest & $Shape
Creates a new PauseActivityRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PauseActivityRequest instance
▸ create(properties?): PauseActivityRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PauseActivityRequest & $Shape
Decodes a PauseActivityRequest 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
PauseActivityRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PauseActivityRequest & $Shape
Decodes a PauseActivityRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PauseActivityRequest
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 PauseActivityRequest message. Does not implicitly temporal.api.workflowservice.v1.PauseActivityRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PauseActivityRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PauseActivityRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PauseActivityRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PauseActivityRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PauseActivityRequest
Creates a PauseActivityRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PauseActivityRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PauseActivityRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PauseActivityRequest | PauseActivityRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object