Skip to main content

Class: 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.

Properties​

identity​

identity: string

The identity of the worker/client

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationCancellation to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationCancellation & $Properties

Creates a new BatchOperationCancellation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationCancellation & $Properties

BatchOperationCancellation instance

Call Signature​

static create(properties?): BatchOperationCancellation

Creates a new BatchOperationCancellation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationCancellation

BatchOperationCancellation instance

decode()​

static decode(reader, length?): BatchOperationCancellation & $Properties

Decodes a BatchOperationCancellation 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​

BatchOperationCancellation & $Properties

BatchOperationCancellation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationCancellation & $Properties

Decodes a BatchOperationCancellation message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationCancellation & $Properties

BatchOperationCancellation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified BatchOperationCancellation message. Does not implicitly temporal.api.batch.v1.BatchOperationCancellation.verify|verify messages.

Parameters​

message​

$Properties

BatchOperationCancellation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified BatchOperationCancellation message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationCancellation.verify|verify messages.

Parameters​

message​

$Properties

BatchOperationCancellation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationCancellation

Creates a BatchOperationCancellation message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

BatchOperationCancellation

BatchOperationCancellation

toObject()​

static toObject(message, options?): object

Creates a plain object from a BatchOperationCancellation message. Also converts values to other types if specified.

Parameters​

message​

BatchOperationCancellation

BatchOperationCancellation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object