Skip to main content

Interface: IStartBatchOperationRequest

workflowservice.v1.IStartBatchOperationRequest

Properties of a StartBatchOperationRequest.

Implemented by​

Properties​

cancellationOperation​

• Optional cancellationOperation: null | IBatchOperationCancellation

StartBatchOperationRequest cancellationOperation

deletionOperation​

• Optional deletionOperation: null | IBatchOperationDeletion

StartBatchOperationRequest deletionOperation

executions​

• Optional executions: null | IWorkflowExecution[]

Executions to apply the batch operation This field and visibility_query are mutually exclusive

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

reason​

• Optional reason: null | string

Reason to perform the batch operation

resetActivitiesOperation​

• Optional resetActivitiesOperation: null | IBatchOperationResetActivities

StartBatchOperationRequest resetActivitiesOperation

resetOperation​

• Optional resetOperation: null | IBatchOperationReset

StartBatchOperationRequest resetOperation

signalOperation​

• Optional signalOperation: null | IBatchOperationSignal

StartBatchOperationRequest signalOperation

terminationOperation​

• Optional terminationOperation: null | IBatchOperationTermination

StartBatchOperationRequest terminationOperation

unpauseActivitiesOperation​

• Optional unpauseActivitiesOperation: null | IBatchOperationUnpauseActivities

StartBatchOperationRequest unpauseActivitiesOperation

updateActivityOptionsOperation​

• Optional updateActivityOptionsOperation: null | IBatchOperationUpdateActivityOptions

StartBatchOperationRequest updateActivityOptionsOperation

updateWorkflowOptionsOperation​

• Optional updateWorkflowOptionsOperation: null | IBatchOperationUpdateWorkflowExecutionOptions

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