Interface: $Properties

v1.StartBatchOperationRequest.$Properties

Properties of a StartBatchOperationRequest.

Hierarchy

• $Properties

  ↳ IStartBatchOperationRequest

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

• Optional executions: null | $Properties[]

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

---

jobId

• Optional jobId: null | string

Job ID defines the unique ID for the batch job

---

maxOperationsPerSecond

• Optional maxOperationsPerSecond: null | 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

• Optional namespace: null | 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

• Optional reason: null | 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

• Optional targetExecutions: null | $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

• Optional visibilityQuery: null | string

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