Skip to main content

Class: StartBatchOperationRequest

Represents a StartBatchOperationRequest.

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​

executions: $Properties[]

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

jobId​

jobId: string

Job ID defines the unique ID for the batch job

maxOperationsPerSecond​

maxOperationsPerSecond: 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​

namespace: 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​

reason: string

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​

targetExecutions: $Properties[]

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​

visibilityQuery: string

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

Methods​

toJSON()​

toJSON(): object

Converts this StartBatchOperationRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartBatchOperationRequest & $Shape

Creates a new StartBatchOperationRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartBatchOperationRequest & $Shape

StartBatchOperationRequest instance

Call Signature​

static create(properties?): StartBatchOperationRequest

Creates a new StartBatchOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartBatchOperationRequest

StartBatchOperationRequest instance

decode()​

static decode(reader, length?): StartBatchOperationRequest & $Shape

Decodes a StartBatchOperationRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

StartBatchOperationRequest & $Shape

StartBatchOperationRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartBatchOperationRequest & $Shape

Decodes a StartBatchOperationRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartBatchOperationRequest & $Shape

StartBatchOperationRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified StartBatchOperationRequest message. Does not implicitly temporal.api.workflowservice.v1.StartBatchOperationRequest.verify|verify messages.

Parameters​

message​

$Properties

StartBatchOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified StartBatchOperationRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartBatchOperationRequest.verify|verify messages.

Parameters​

message​

$Properties

StartBatchOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartBatchOperationRequest

Creates a StartBatchOperationRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

StartBatchOperationRequest

StartBatchOperationRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a StartBatchOperationRequest message. Also converts values to other types if specified.

Parameters​

message​

StartBatchOperationRequest

StartBatchOperationRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object