Class: BatchOperationCancellation
batch.v1.BatchOperationCancellation
BatchOperationCancellation sends cancel requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest. Ignore first_execution_run_id because this is used for single workflow operation.
Implements
Constructors
constructor
• new BatchOperationCancellation(properties?): BatchOperationCancellation
Constructs a new BatchOperationCancellation.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationCancellation | Properties to set |
Returns
Properties
identity
• identity: string
The identity of the worker/client
Implementation of
IBatchOperationCancellation.identity
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationCancellation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationCancellation
Creates a new BatchOperationCancellation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationCancellation | Properties to set |
Returns
BatchOperationCancellation instance
decode
▸ decode(reader, length?): BatchOperationCancellation
Decodes a BatchOperationCancellation 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
BatchOperationCancellation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationCancellation
Decodes a BatchOperationCancellation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationCancellation
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 BatchOperationCancellation message. Does not implicitly temporal.api.batch.v1.BatchOperationCancellation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationCancellation | BatchOperationCancellation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationCancellation message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationCancellation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationCancellation | BatchOperationCancellation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationCancellation
Creates a BatchOperationCancellation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationCancellation
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationCancellation
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 BatchOperationCancellation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationCancellation | BatchOperationCancellation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object