Class: BatchOperationDeletion
BatchOperationDeletion sends deletion requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.DeleteWorkflowExecutionRequest.
Properties
identity
identity:
string
The identity of the worker/client
Methods
toJSON()
toJSON():
object
Converts this BatchOperationDeletion to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):BatchOperationDeletion&$Properties
Creates a new BatchOperationDeletion instance using the specified properties.
Parameters
properties?
Properties to set
Returns
BatchOperationDeletion & $Properties
BatchOperationDeletion instance
Call Signature
staticcreate(properties?):BatchOperationDeletion
Creates a new BatchOperationDeletion instance using the specified properties.
Parameters
properties?
Properties to set
Returns
BatchOperationDeletion
BatchOperationDeletion instance
decode()
staticdecode(reader,length?):BatchOperationDeletion&$Properties
Decodes a BatchOperationDeletion message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
BatchOperationDeletion & $Properties
BatchOperationDeletion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):BatchOperationDeletion&$Properties
Decodes a BatchOperationDeletion message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
BatchOperationDeletion & $Properties
BatchOperationDeletion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified BatchOperationDeletion message. Does not implicitly temporal.api.batch.v1.BatchOperationDeletion.verify|verify messages.
Parameters
message
BatchOperationDeletion message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified BatchOperationDeletion message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationDeletion.verify|verify messages.
Parameters
message
BatchOperationDeletion message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):BatchOperationDeletion
Creates a BatchOperationDeletion message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
BatchOperationDeletion
BatchOperationDeletion
toObject()
statictoObject(message,options?):object
Creates a plain object from a BatchOperationDeletion message. Also converts values to other types if specified.
Parameters
message
BatchOperationDeletion
BatchOperationDeletion
options?
IConversionOptions
Conversion options
Returns
object
Plain object