Class: StartBatchOperationRequest

workflowservice.v1.StartBatchOperationRequest

Represents a StartBatchOperationRequest.

Implements

• IStartBatchOperationRequest

Constructors

constructor

• new StartBatchOperationRequest(properties?): StartBatchOperationRequest

Constructs a new StartBatchOperationRequest.

Parameters

Name	Type	Description
properties?	IStartBatchOperationRequest	Properties to set

Returns

StartBatchOperationRequest

Properties

cancelActivitiesOperation

• Optional cancelActivitiesOperation: null | IBatchOperationCancelActivities

StartBatchOperationRequest cancelActivitiesOperation.

Implementation of

IStartBatchOperationRequest.cancelActivitiesOperation

---

cancellationOperation

• Optional cancellationOperation: null | IBatchOperationCancellation

StartBatchOperationRequest cancellationOperation.

Implementation of

IStartBatchOperationRequest.cancellationOperation

---

deleteActivitiesOperation

• Optional deleteActivitiesOperation: null | IBatchOperationDeleteActivities

StartBatchOperationRequest deleteActivitiesOperation.

Implementation of

IStartBatchOperationRequest.deleteActivitiesOperation

---

deletionOperation

• Optional deletionOperation: null | IBatchOperationDeletion

StartBatchOperationRequest deletionOperation.

Implementation of

IStartBatchOperationRequest.deletionOperation

---

executions

• executions: IWorkflowExecution[]

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

Implementation of

IStartBatchOperationRequest.executions

---

jobId

• jobId: string

Job ID defines the unique ID for the batch job

Implementation of

IStartBatchOperationRequest.jobId

---

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.

Implementation of

IStartBatchOperationRequest.maxOperationsPerSecond

---

namespace

• namespace: string

Namespace that contains the batch operation

Implementation of

IStartBatchOperationRequest.namespace

---

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

Implementation of

IStartBatchOperationRequest.reason

---

resetActivitiesOperation

• Optional resetActivitiesOperation: null | IBatchOperationResetActivities

StartBatchOperationRequest resetActivitiesOperation.

Implementation of

IStartBatchOperationRequest.resetActivitiesOperation

---

resetOperation

• Optional resetOperation: null | IBatchOperationReset

StartBatchOperationRequest resetOperation.

Implementation of

IStartBatchOperationRequest.resetOperation

---

signalOperation

• Optional signalOperation: null | IBatchOperationSignal

StartBatchOperationRequest signalOperation.

Implementation of

IStartBatchOperationRequest.signalOperation

---

targetExecutions

• targetExecutions: IExecution[]

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

Implementation of

IStartBatchOperationRequest.targetExecutions

---

terminateActivitiesOperation

• Optional terminateActivitiesOperation: null | IBatchOperationTerminateActivities

StartBatchOperationRequest terminateActivitiesOperation.

Implementation of

IStartBatchOperationRequest.terminateActivitiesOperation

---

terminationOperation

• Optional terminationOperation: null | IBatchOperationTermination

StartBatchOperationRequest terminationOperation.

Implementation of

IStartBatchOperationRequest.terminationOperation

---

unpauseActivitiesOperation

• Optional unpauseActivitiesOperation: null | IBatchOperationUnpauseActivities

StartBatchOperationRequest unpauseActivitiesOperation.

Implementation of

IStartBatchOperationRequest.unpauseActivitiesOperation

---

updateActivityOptionsOperation

• Optional updateActivityOptionsOperation: null | IBatchOperationUpdateActivityOptions

StartBatchOperationRequest updateActivityOptionsOperation.

Implementation of

IStartBatchOperationRequest.updateActivityOptionsOperation

---

updateWorkflowOptionsOperation

• Optional updateWorkflowOptionsOperation: null | IBatchOperationUpdateWorkflowExecutionOptions

StartBatchOperationRequest updateWorkflowOptionsOperation.

Implementation of

IStartBatchOperationRequest.updateWorkflowOptionsOperation

---

visibilityQuery

• visibilityQuery: string

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

Implementation of

IStartBatchOperationRequest.visibilityQuery

Methods

toJSON

▸ toJSON(): Object

Converts this StartBatchOperationRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartBatchOperationRequest

Creates a new StartBatchOperationRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStartBatchOperationRequest	Properties to set

Returns

StartBatchOperationRequest

StartBatchOperationRequest instance

---

decode

▸ decode(reader, length?): StartBatchOperationRequest

Decodes a StartBatchOperationRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

StartBatchOperationRequest

StartBatchOperationRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartBatchOperationRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

StartBatchOperationRequest

StartBatchOperationRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartBatchOperationRequest	StartBatchOperationRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartBatchOperationRequest	StartBatchOperationRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartBatchOperationRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartBatchOperationRequest

StartBatchOperationRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartBatchOperationRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartBatchOperationRequest	StartBatchOperationRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object