Class: BatchOperationUnpauseActivities
batch.v1.BatchOperationUnpauseActivities
BatchOperationUnpauseActivities sends unpause requests to batch workflows.
Implements
Constructors
constructor
• new BatchOperationUnpauseActivities(properties?): BatchOperationUnpauseActivities
Constructs a new BatchOperationUnpauseActivities.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationUnpauseActivities | Properties to set |
Returns
BatchOperationUnpauseActivities
Properties
activity
• Optional activity: "type" | "matchAll"
The activity to unpause. If match_all is set to true, all activities will be unpaused.
identity
• identity: string
The identity of the worker/client.
Implementation of
IBatchOperationUnpauseActivities.identity
jitter
• Optional jitter: null | IDuration
If set, the activity will start at a random time within the specified jitter duration, introducing variability to the start time.
Implementation of
IBatchOperationUnpauseActivities.jitter
matchAll
• Optional matchAll: null | boolean
BatchOperationUnpauseActivities matchAll.
Implementation of
IBatchOperationUnpauseActivities.matchAll
resetAttempts
• resetAttempts: boolean
Providing this flag will also reset the number of attempts.
Implementation of
IBatchOperationUnpauseActivities.resetAttempts
resetHeartbeat
• resetHeartbeat: boolean
Providing this flag will also reset the heartbeat details.
Implementation of
IBatchOperationUnpauseActivities.resetHeartbeat
type
• Optional type: null | string
BatchOperationUnpauseActivities type.
Implementation of
IBatchOperationUnpauseActivities.type
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationUnpauseActivities to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationUnpauseActivities
Creates a new BatchOperationUnpauseActivities instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationUnpauseActivities | Properties to set |
Returns
BatchOperationUnpauseActivities
BatchOperationUnpauseActivities instance
decode
▸ decode(reader, length?): BatchOperationUnpauseActivities
Decodes a BatchOperationUnpauseActivities 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
BatchOperationUnpauseActivities
BatchOperationUnpauseActivities
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationUnpauseActivities
Decodes a BatchOperationUnpauseActivities message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationUnpauseActivities
BatchOperationUnpauseActivities
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 BatchOperationUnpauseActivities message. Does not implicitly temporal.api.batch.v1.BatchOperationUnpauseActivities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationUnpauseActivities | BatchOperationUnpauseActivities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationUnpauseActivities message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationUnpauseActivities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationUnpauseActivities | BatchOperationUnpauseActivities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationUnpauseActivities
Creates a BatchOperationUnpauseActivities message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationUnpauseActivities
BatchOperationUnpauseActivities
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationUnpauseActivities
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 BatchOperationUnpauseActivities message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationUnpauseActivities | BatchOperationUnpauseActivities |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object