Class: BatchOperationResetActivities
batch.v1.BatchOperationResetActivities
BatchOperationResetActivities sends activity reset requests in a batch. NOTE: keep in sync with temporal.api.workflowservice.v1.ResetActivityRequest
Properties
activity
• Optional activity: "type" | "matchAll"
The activities to reset. If match_all is set to true, all activities will be reset.
identity
• identity: string
The identity of the worker/client.
jitter
• Optional jitter: null | $Properties
If set, the activity will start at a random time within the specified jitter duration, introducing variability to the start time.
keepPaused
• keepPaused: boolean
If activity is paused, it will remain paused after reset
matchAll
• Optional matchAll: null | boolean
BatchOperationResetActivities matchAll.
resetAttempts
• resetAttempts: boolean
Setting this flag will also reset the number of attempts.
resetHeartbeat
• resetHeartbeat: boolean
Setting this flag will also reset the heartbeat details.
restoreOriginalOptions
• restoreOriginalOptions: boolean
If set, the activity options will be restored to the defaults. Default options are then options activity was created with. They are part of the first ActivityTaskScheduled event.
type
• Optional type: null | string
BatchOperationResetActivities type.
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationResetActivities to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationResetActivities & $Shape
Creates a new BatchOperationResetActivities instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
BatchOperationResetActivities & $Shape
BatchOperationResetActivities instance
▸ create(properties?): BatchOperationResetActivities
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BatchOperationResetActivities & $Shape
Decodes a BatchOperationResetActivities 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
BatchOperationResetActivities & $Shape
BatchOperationResetActivities
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationResetActivities & $Shape
Decodes a BatchOperationResetActivities message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationResetActivities & $Shape
BatchOperationResetActivities
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 BatchOperationResetActivities message. Does not implicitly temporal.api.batch.v1.BatchOperationResetActivities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationResetActivities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationResetActivities message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationResetActivities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationResetActivities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationResetActivities
Creates a BatchOperationResetActivities message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationResetActivities
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BatchOperationResetActivities message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationResetActivities | BatchOperationResetActivities |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object