Skip to main content

Interface: $Properties

Properties of a StartBatchOperationRequest.

Extended by​

Properties​

cancelActivitiesOperation?​

optional cancelActivitiesOperation?: $Properties | null

StartBatchOperationRequest cancelActivitiesOperation

cancellationOperation?​

optional cancellationOperation?: $Properties | null

StartBatchOperationRequest cancellationOperation

deleteActivitiesOperation?​

optional deleteActivitiesOperation?: $Properties | null

StartBatchOperationRequest deleteActivitiesOperation

deletionOperation?​

optional deletionOperation?: $Properties | null

StartBatchOperationRequest deletionOperation

executions?​

optional executions?: $Properties[] | null

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

jobId?​

optional jobId?: string | null

Job ID defines the unique ID for the batch job

maxOperationsPerSecond?​

optional maxOperationsPerSecond?: number | null

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?: string | null

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?: string | null

Reason to perform the batch operation

resetActivitiesOperation?​

optional resetActivitiesOperation?: $Properties | null

StartBatchOperationRequest resetActivitiesOperation

resetOperation?​

optional resetOperation?: $Properties | null

StartBatchOperationRequest resetOperation

signalOperation?​

optional signalOperation?: $Properties | null

StartBatchOperationRequest signalOperation

targetExecutions?​

optional targetExecutions?: $Properties[] | null

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

terminateActivitiesOperation?​

optional terminateActivitiesOperation?: $Properties | null

StartBatchOperationRequest terminateActivitiesOperation

terminationOperation?​

optional terminationOperation?: $Properties | null

StartBatchOperationRequest terminationOperation

unpauseActivitiesOperation?​

optional unpauseActivitiesOperation?: $Properties | null

StartBatchOperationRequest unpauseActivitiesOperation

updateActivityOptionsOperation?​

optional updateActivityOptionsOperation?: $Properties | null

StartBatchOperationRequest updateActivityOptionsOperation

updateWorkflowOptionsOperation?​

optional updateWorkflowOptionsOperation?: $Properties | null

StartBatchOperationRequest updateWorkflowOptionsOperation

visibilityQuery?​

optional visibilityQuery?: string | null

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