Skip to main content

Interface: IStartBatchOperationRequest

Properties of a StartBatchOperationRequest.

Extends​

Properties​

cancelActivitiesOperation?​

optional cancelActivitiesOperation?: $Properties | null

StartBatchOperationRequest cancelActivitiesOperation

Inherited from​

$Properties.cancelActivitiesOperation

cancellationOperation?​

optional cancellationOperation?: $Properties | null

StartBatchOperationRequest cancellationOperation

Inherited from​

$Properties.cancellationOperation

deleteActivitiesOperation?​

optional deleteActivitiesOperation?: $Properties | null

StartBatchOperationRequest deleteActivitiesOperation

Inherited from​

$Properties.deleteActivitiesOperation

deletionOperation?​

optional deletionOperation?: $Properties | null

StartBatchOperationRequest deletionOperation

Inherited from​

$Properties.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.

Inherited from​

$Properties.executions

jobId?​

optional jobId?: string | null

Job ID defines the unique ID for the batch job

Inherited from​

$Properties.jobId

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.

Inherited from​

$Properties.maxOperationsPerSecond

namespace?​

optional namespace?: string | null

Namespace that contains the batch operation

Inherited from​

$Properties.namespace

operation?​

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

Operation input

Inherited from​

$Properties.operation

reason?​

optional reason?: string | null

Reason to perform the batch operation

Inherited from​

$Properties.reason

resetActivitiesOperation?​

optional resetActivitiesOperation?: $Properties | null

StartBatchOperationRequest resetActivitiesOperation

Inherited from​

$Properties.resetActivitiesOperation

resetOperation?​

optional resetOperation?: $Properties | null

StartBatchOperationRequest resetOperation

Inherited from​

$Properties.resetOperation

signalOperation?​

optional signalOperation?: $Properties | null

StartBatchOperationRequest signalOperation

Inherited from​

$Properties.signalOperation

targetExecutions?​

optional targetExecutions?: $Properties[] | null

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

Inherited from​

$Properties.targetExecutions

terminateActivitiesOperation?​

optional terminateActivitiesOperation?: $Properties | null

StartBatchOperationRequest terminateActivitiesOperation

Inherited from​

$Properties.terminateActivitiesOperation

terminationOperation?​

optional terminationOperation?: $Properties | null

StartBatchOperationRequest terminationOperation

Inherited from​

$Properties.terminationOperation

unpauseActivitiesOperation?​

optional unpauseActivitiesOperation?: $Properties | null

StartBatchOperationRequest unpauseActivitiesOperation

Inherited from​

$Properties.unpauseActivitiesOperation

updateActivityOptionsOperation?​

optional updateActivityOptionsOperation?: $Properties | null

StartBatchOperationRequest updateActivityOptionsOperation

Inherited from​

$Properties.updateActivityOptionsOperation

updateWorkflowOptionsOperation?​

optional updateWorkflowOptionsOperation?: $Properties | null

StartBatchOperationRequest updateWorkflowOptionsOperation

Inherited from​

$Properties.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

Inherited from​

$Properties.visibilityQuery