Class: UnpauseActivityRequest
workflowservice.v1.UnpauseActivityRequest
Represents an UnpauseActivityRequest.
Implements
Constructors
constructor
• new UnpauseActivityRequest(properties?): UnpauseActivityRequest
Constructs a new UnpauseActivityRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUnpauseActivityRequest | Properties to set |
Returns
Properties
activity
• Optional activity: "id" | "type" | "unpauseAll"
either activity id or activity type must be provided
execution
• Optional execution: null | IWorkflowExecution
Execution info of the workflow which scheduled this activity
Implementation of
IUnpauseActivityRequest.execution
id
• Optional id: null | string
Only the activity with this ID will be unpaused.
Implementation of
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
IUnpauseActivityRequest.identity
jitter
• Optional jitter: null | IDuration
If set, the activity will start at a random time within the specified jitter duration.
Implementation of
IUnpauseActivityRequest.jitter
namespace
• namespace: string
Namespace of the workflow which scheduled this activity.
Implementation of
IUnpauseActivityRequest.namespace
resetAttempts
• resetAttempts: boolean
Providing this flag will also reset the number of attempts.
Implementation of
IUnpauseActivityRequest.resetAttempts
resetHeartbeat
• resetHeartbeat: boolean
Providing this flag will also reset the heartbeat details.
Implementation of
IUnpauseActivityRequest.resetHeartbeat
type
• Optional type: null | string
Unpause all running activities with of this type.
Implementation of
unpauseAll
• Optional unpauseAll: null | boolean
Unpause all running activities.
Implementation of
IUnpauseActivityRequest.unpauseAll
Methods
toJSON
▸ toJSON(): Object
Converts this UnpauseActivityRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UnpauseActivityRequest
Creates a new UnpauseActivityRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUnpauseActivityRequest | Properties to set |
Returns
UnpauseActivityRequest instance
decode
▸ decode(reader, length?): UnpauseActivityRequest
Decodes an UnpauseActivityRequest 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
UnpauseActivityRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UnpauseActivityRequest
Decodes an UnpauseActivityRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UnpauseActivityRequest
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 UnpauseActivityRequest message. Does not implicitly temporal.api.workflowservice.v1.UnpauseActivityRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUnpauseActivityRequest | UnpauseActivityRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UnpauseActivityRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UnpauseActivityRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUnpauseActivityRequest | UnpauseActivityRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UnpauseActivityRequest
Creates an UnpauseActivityRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UnpauseActivityRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UnpauseActivityRequest
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 UnpauseActivityRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UnpauseActivityRequest | UnpauseActivityRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object