Class: BatchOperationTermination
batch.v1.BatchOperationTermination
BatchOperationTermination sends terminate requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.TerminateWorkflowExecutionRequest. Ignore first_execution_run_id because this is used for single workflow operation.
Properties
details
• Optional details: null | $Properties
Serialized value(s) to provide to the termination event
identity
• identity: string
The identity of the worker/client
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationTermination to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationTermination & $Properties
Creates a new BatchOperationTermination instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BatchOperationTermination & $Properties
BatchOperationTermination instance
▸ create(properties?): BatchOperationTermination
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BatchOperationTermination & $Properties
Decodes a BatchOperationTermination 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
BatchOperationTermination & $Properties
BatchOperationTermination
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationTermination & $Properties
Decodes a BatchOperationTermination message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationTermination & $Properties
BatchOperationTermination
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 BatchOperationTermination message. Does not implicitly temporal.api.batch.v1.BatchOperationTermination.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationTermination message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationTermination message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationTermination.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationTermination message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationTermination
Creates a BatchOperationTermination message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationTermination
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BatchOperationTermination message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationTermination | BatchOperationTermination |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object