Class: PauseActivityByIdRequest
workflowservice.v1.PauseActivityByIdRequest
Represents a PauseActivityByIdRequest.
Implements
Constructors
constructor
• new PauseActivityByIdRequest(properties?): PauseActivityByIdRequest
Constructs a new PauseActivityByIdRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPauseActivityByIdRequest | Properties to set |
Returns
Properties
activityId
• activityId: string
ID of the activity we're updating.
Implementation of
IPauseActivityByIdRequest.activityId
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
IPauseActivityByIdRequest.identity
namespace
• namespace: string
Namespace of the workflow which scheduled this activity.
Implementation of
IPauseActivityByIdRequest.namespace
requestId
• requestId: string
Used to de-dupe requests.
Implementation of
IPauseActivityByIdRequest.requestId
runId
• runId: string
Run ID of the workflow which scheduled this activity. If empty - latest workflow is used.
Implementation of
IPauseActivityByIdRequest.runId
workflowId
• workflowId: string
ID of the workflow which scheduled this activity.
Implementation of
IPauseActivityByIdRequest.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this PauseActivityByIdRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PauseActivityByIdRequest
Creates a new PauseActivityByIdRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPauseActivityByIdRequest | Properties to set |
Returns
PauseActivityByIdRequest instance
decode
▸ decode(reader, length?): PauseActivityByIdRequest
Decodes a PauseActivityByIdRequest 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
PauseActivityByIdRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PauseActivityByIdRequest
Decodes a PauseActivityByIdRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PauseActivityByIdRequest
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 PauseActivityByIdRequest message. Does not implicitly temporal.api.workflowservice.v1.PauseActivityByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPauseActivityByIdRequest | PauseActivityByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PauseActivityByIdRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PauseActivityByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPauseActivityByIdRequest | PauseActivityByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PauseActivityByIdRequest
Creates a PauseActivityByIdRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PauseActivityByIdRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PauseActivityByIdRequest
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 PauseActivityByIdRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PauseActivityByIdRequest | PauseActivityByIdRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object