Skip to main content

Interface: IStartBatchOperationRequest

workflowservice.v1.IStartBatchOperationRequest

Properties of a StartBatchOperationRequest.

Hierarchy​

Properties​

cancelActivitiesOperation​

• Optional cancelActivitiesOperation: null | $Properties

StartBatchOperationRequest cancelActivitiesOperation

Inherited from​

$Properties.cancelActivitiesOperation

cancellationOperation​

• Optional cancellationOperation: null | $Properties

StartBatchOperationRequest cancellationOperation

Inherited from​

$Properties.cancellationOperation

deleteActivitiesOperation​

• Optional deleteActivitiesOperation: null | $Properties

StartBatchOperationRequest deleteActivitiesOperation

Inherited from​

$Properties.deleteActivitiesOperation

deletionOperation​

• Optional deletionOperation: null | $Properties

StartBatchOperationRequest deletionOperation

Inherited from​

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

Inherited from​

$Properties.executions

jobId​

• Optional jobId: null | string

Job ID defines the unique ID for the batch job

Inherited from​

$Properties.jobId

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.

Inherited from​

$Properties.maxOperationsPerSecond

namespace​

• Optional namespace: null | string

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

Reason to perform the batch operation

Inherited from​

$Properties.reason

resetActivitiesOperation​

• Optional resetActivitiesOperation: null | $Properties

StartBatchOperationRequest resetActivitiesOperation

Inherited from​

$Properties.resetActivitiesOperation

resetOperation​

• Optional resetOperation: null | $Properties

StartBatchOperationRequest resetOperation

Inherited from​

$Properties.resetOperation

signalOperation​

• Optional signalOperation: null | $Properties

StartBatchOperationRequest signalOperation

Inherited from​

$Properties.signalOperation

targetExecutions​

• Optional targetExecutions: null | $Properties[]

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

Inherited from​

$Properties.targetExecutions

terminateActivitiesOperation​

• Optional terminateActivitiesOperation: null | $Properties

StartBatchOperationRequest terminateActivitiesOperation

Inherited from​

$Properties.terminateActivitiesOperation

terminationOperation​

• Optional terminationOperation: null | $Properties

StartBatchOperationRequest terminationOperation

Inherited from​

$Properties.terminationOperation

unpauseActivitiesOperation​

• Optional unpauseActivitiesOperation: null | $Properties

StartBatchOperationRequest unpauseActivitiesOperation

Inherited from​

$Properties.unpauseActivitiesOperation

updateActivityOptionsOperation​

• Optional updateActivityOptionsOperation: null | $Properties

StartBatchOperationRequest updateActivityOptionsOperation

Inherited from​

$Properties.updateActivityOptionsOperation

updateWorkflowOptionsOperation​

• Optional updateWorkflowOptionsOperation: null | $Properties

StartBatchOperationRequest updateWorkflowOptionsOperation

Inherited from​

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

Inherited from​

$Properties.visibilityQuery