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