Class: StartBatchOperationRequest

workflowservice.v1.StartBatchOperationRequest

Represents a StartBatchOperationRequest.

Properties

cancelActivitiesOperation

• Optional cancelActivitiesOperation: null | $Properties

StartBatchOperationRequest cancelActivitiesOperation.

---

cancellationOperation

• Optional cancellationOperation: null | $Properties

StartBatchOperationRequest cancellationOperation.

---

deleteActivitiesOperation

• Optional deleteActivitiesOperation: null | $Properties

StartBatchOperationRequest deleteActivitiesOperation.

---

deletionOperation

• Optional deletionOperation: null | $Properties

StartBatchOperationRequest deletionOperation.

---

executions

• executions: $Properties[]

Executions to apply the batch operation This field and visibility_query are mutually exclusive DEPRECATED: Use target_executions instead.

---

jobId

• jobId: string

Job ID defines the unique ID for the batch job

---

maxOperationsPerSecond

• maxOperationsPerSecond: number

Limit for the number of operations processed per second within this batch. Its purpose is to reduce the stress on the system caused by batch operations, which helps to prevent system overload and minimize potential delays in executing ongoing tasks for user workers. Note that when no explicit limit is provided, the server will operate according to its limit defined by the dynamic configuration key worker.batcherRPS. This also applies if the value in this field exceeds the server's configured limit.

---

namespace

• namespace: string

Namespace that contains the batch operation

---

operation

• Optional operation: "terminationOperation" | "signalOperation" | "cancellationOperation" | "deletionOperation" | "resetOperation" | "updateWorkflowOptionsOperation" | "unpauseActivitiesOperation" | "resetActivitiesOperation" | "updateActivityOptionsOperation" | "cancelActivitiesOperation" | "terminateActivitiesOperation" | "deleteActivitiesOperation"

Operation input

---

reason

• reason: string

Reason to perform the batch operation

---

resetActivitiesOperation

• Optional resetActivitiesOperation: null | $Properties

StartBatchOperationRequest resetActivitiesOperation.

---

resetOperation

• Optional resetOperation: null | $Properties

StartBatchOperationRequest resetOperation.

---

signalOperation

• Optional signalOperation: null | $Properties

StartBatchOperationRequest signalOperation.

---

targetExecutions

• targetExecutions: $Properties[]

Target executions to apply the batch operation. This field and visibility_query are mutually exclusive.

---

terminateActivitiesOperation

• Optional terminateActivitiesOperation: null | $Properties

StartBatchOperationRequest terminateActivitiesOperation.

---

terminationOperation

• Optional terminationOperation: null | $Properties

StartBatchOperationRequest terminationOperation.

---

unpauseActivitiesOperation

• Optional unpauseActivitiesOperation: null | $Properties

StartBatchOperationRequest unpauseActivitiesOperation.

---

updateActivityOptionsOperation

• Optional updateActivityOptionsOperation: null | $Properties

StartBatchOperationRequest updateActivityOptionsOperation.

---

updateWorkflowOptionsOperation

• Optional updateWorkflowOptionsOperation: null | $Properties

StartBatchOperationRequest updateWorkflowOptionsOperation.

---

visibilityQuery

• visibilityQuery: string

Visibility query defines the the group of workflow to apply the batch operation This field and executions are mutually exclusive

Methods

toJSON

▸ toJSON(): Object

Converts this StartBatchOperationRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartBatchOperationRequest & $Shape

Creates a new StartBatchOperationRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

StartBatchOperationRequest & $Shape

StartBatchOperationRequest instance

▸ create(properties?): StartBatchOperationRequest

Parameters

Name	Type
properties?	$Properties

Returns

StartBatchOperationRequest

---

decode

▸ decode(reader, length?): StartBatchOperationRequest & $Shape

Decodes a StartBatchOperationRequest 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

StartBatchOperationRequest & $Shape

StartBatchOperationRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartBatchOperationRequest & $Shape

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

StartBatchOperationRequest & $Shape

StartBatchOperationRequest

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 StartBatchOperationRequest message. Does not implicitly temporal.api.workflowservice.v1.StartBatchOperationRequest.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	StartBatchOperationRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	$Properties	StartBatchOperationRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartBatchOperationRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartBatchOperationRequest

StartBatchOperationRequest

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartBatchOperationRequest	StartBatchOperationRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object