Class: UnpauseActivityExecutionRequest
workflowservice.v1.UnpauseActivityExecutionRequest
Represents an UnpauseActivityExecutionRequest.
Implements
Constructors
constructor
• new UnpauseActivityExecutionRequest(properties?): UnpauseActivityExecutionRequest
Constructs a new UnpauseActivityExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUnpauseActivityExecutionRequest | Properties to set |
Returns
UnpauseActivityExecutionRequest
Properties
activityId
• activityId: string
The ID of the activity to target.
Implementation of
IUnpauseActivityExecutionRequest.activityId
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
IUnpauseActivityExecutionRequest.identity
jitter
• Optional jitter: null | IDuration
If set, the activity will start at a random time within the specified jitter duration.
Implementation of
IUnpauseActivityExecutionRequest.jitter
namespace
• namespace: string
Namespace of the workflow which scheduled this activity.
Implementation of
IUnpauseActivityExecutionRequest.namespace
reason
• reason: string
Reason to unpause the activity.
Implementation of
IUnpauseActivityExecutionRequest.reason
resetAttempts
• resetAttempts: boolean
Providing this flag will also reset the number of attempts.
Implementation of
IUnpauseActivityExecutionRequest.resetAttempts
resetHeartbeat
• resetHeartbeat: boolean
Providing this flag will also reset the heartbeat details.
Implementation of
IUnpauseActivityExecutionRequest.resetHeartbeat
resourceId
• resourceId: string
Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
Implementation of
IUnpauseActivityExecutionRequest.resourceId
runId
• runId: string
Run ID of the workflow or standalone activity.
Implementation of
IUnpauseActivityExecutionRequest.runId
workflowId
• workflowId: string
If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.
Implementation of
IUnpauseActivityExecutionRequest.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this UnpauseActivityExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UnpauseActivityExecutionRequest
Creates a new UnpauseActivityExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUnpauseActivityExecutionRequest | Properties to set |
Returns
UnpauseActivityExecutionRequest
UnpauseActivityExecutionRequest instance
decode
▸ decode(reader, length?): UnpauseActivityExecutionRequest
Decodes an UnpauseActivityExecutionRequest 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
UnpauseActivityExecutionRequest
UnpauseActivityExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UnpauseActivityExecutionRequest
Decodes an UnpauseActivityExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UnpauseActivityExecutionRequest
UnpauseActivityExecutionRequest
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 UnpauseActivityExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.UnpauseActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUnpauseActivityExecutionRequest | UnpauseActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UnpauseActivityExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UnpauseActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUnpauseActivityExecutionRequest | UnpauseActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UnpauseActivityExecutionRequest
Creates an UnpauseActivityExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UnpauseActivityExecutionRequest
UnpauseActivityExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UnpauseActivityExecutionRequest
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 UnpauseActivityExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UnpauseActivityExecutionRequest | UnpauseActivityExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object