Class: BatchOperationReset
BatchOperationReset sends reset requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.
Implements
Constructors
constructor
• new BatchOperationReset(properties?): BatchOperationReset
Constructs a new BatchOperationReset.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationReset | Properties to set |
Returns
Properties
identity
• identity: string
The identity of the worker/client.
Implementation of
options
• Optional options: null | IResetOptions
Describes what to reset to and how. If set, reset_type and reset_reapply_type are ignored.
Implementation of
resetReapplyType
• resetReapplyType: ResetReapplyType
History event reapply options (deprecated, use options).
Implementation of
IBatchOperationReset.resetReapplyType
resetType
• resetType: ResetType
Reset type (deprecated, use options).
Implementation of
IBatchOperationReset.resetType
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationReset to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationReset
Creates a new BatchOperationReset instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationReset | Properties to set |
Returns
BatchOperationReset instance
decode
▸ decode(reader, length?): BatchOperationReset
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
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 | IBatchOperationReset | 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 | IBatchOperationReset | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationReset
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 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