Class: BatchOperationReset
BatchOperationReset sends reset requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.
Properties
identity
• identity: string
The identity of the worker/client.
options
• Optional options: null | $Properties
Describes what to reset to and how. If set, reset_type and reset_reapply_type are ignored.
postResetOperations
• postResetOperations: $Properties[]
Operations to perform after the workflow has been reset. These operations will be applied to the new run of the workflow execution in the order they are provided. All operations are applied to the workflow before the first new workflow task is generated
resetReapplyType
• resetReapplyType: ResetReapplyType
Deprecated. Use options.
resetType
• resetType: ResetType
Deprecated. Use options.
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationReset to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationReset & $Shape
Creates a new BatchOperationReset instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
BatchOperationReset instance
▸ create(properties?): BatchOperationReset
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BatchOperationReset & $Shape
Decodes a BatchOperationReset 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
BatchOperationReset
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationReset & $Shape
Decodes a BatchOperationReset message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationReset
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 BatchOperationReset message. Does not implicitly temporal.api.batch.v1.BatchOperationReset.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationReset message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationReset message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationReset.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationReset message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationReset
Creates a BatchOperationReset message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationReset
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BatchOperationReset message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationReset | BatchOperationReset |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object