Namespace: WorkflowService

workflowservice.v1.WorkflowService

Type Aliases

CountActivityExecutions

Ƭ CountActivityExecutions: Object

CountActivityExecutions is a visibility API to count activity executions in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICountActivityExecutionsRequest
callback	CountActivityExecutionsCallback

Returns

void

▸ (request): Promise<CountActivityExecutionsResponse>

Parameters

Name	Type
request	ICountActivityExecutionsRequest

Returns

Promise<CountActivityExecutionsResponse>

Type declaration

Name	Type
name	"CountActivityExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/CountActivityExecutions"
requestStream	undefined
requestType	"CountActivityExecutionsRequest"
responseStream	undefined
responseType	"CountActivityExecutionsResponse"

---

CountActivityExecutionsCallback

Ƭ CountActivityExecutionsCallback: (error: Error | null, response?: CountActivityExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#countActivityExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CountActivityExecutionsResponse	CountActivityExecutionsResponse

Returns

void

---

CountNexusOperationExecutions

Ƭ CountNexusOperationExecutions: Object

CountNexusOperationExecutions is a visibility API to count Nexus operations in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICountNexusOperationExecutionsRequest
callback	CountNexusOperationExecutionsCallback

Returns

void

▸ (request): Promise<CountNexusOperationExecutionsResponse>

Parameters

Name	Type
request	ICountNexusOperationExecutionsRequest

Returns

Promise<CountNexusOperationExecutionsResponse>

Type declaration

Name	Type
name	"CountNexusOperationExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/CountNexusOperationExecutions"
requestStream	undefined
requestType	"CountNexusOperationExecutionsRequest"
responseStream	undefined
responseType	"CountNexusOperationExecutionsResponse"

---

CountNexusOperationExecutionsCallback

Ƭ CountNexusOperationExecutionsCallback: (error: Error | null, response?: CountNexusOperationExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#countNexusOperationExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CountNexusOperationExecutionsResponse	CountNexusOperationExecutionsResponse

Returns

void

---

CountSchedules

Ƭ CountSchedules: Object

CountSchedules is a visibility API to count schedules in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICountSchedulesRequest
callback	CountSchedulesCallback

Returns

void

▸ (request): Promise<CountSchedulesResponse>

Parameters

Name	Type
request	ICountSchedulesRequest

Returns

Promise<CountSchedulesResponse>

Type declaration

Name	Type
name	"CountSchedules"
path	"/temporal.api.workflowservice.v1.WorkflowService/CountSchedules"
requestStream	undefined
requestType	"CountSchedulesRequest"
responseStream	undefined
responseType	"CountSchedulesResponse"

---

CountSchedulesCallback

Ƭ CountSchedulesCallback: (error: Error | null, response?: CountSchedulesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#countSchedules.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CountSchedulesResponse	CountSchedulesResponse

Returns

void

---

CountWorkers

Ƭ CountWorkers: Object

CountWorkers counts the number of workers in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICountWorkersRequest
callback	CountWorkersCallback

Returns

void

▸ (request): Promise<CountWorkersResponse>

Parameters

Name	Type
request	ICountWorkersRequest

Returns

Promise<CountWorkersResponse>

Type declaration

Name	Type
name	"CountWorkers"
path	"/temporal.api.workflowservice.v1.WorkflowService/CountWorkers"
requestStream	undefined
requestType	"CountWorkersRequest"
responseStream	undefined
responseType	"CountWorkersResponse"

---

CountWorkersCallback

Ƭ CountWorkersCallback: (error: Error | null, response?: CountWorkersResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#countWorkers.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CountWorkersResponse	CountWorkersResponse

Returns

void

---

CountWorkflowExecutions

Ƭ CountWorkflowExecutions: Object

CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICountWorkflowExecutionsRequest
callback	CountWorkflowExecutionsCallback

Returns

void

▸ (request): Promise<CountWorkflowExecutionsResponse>

Parameters

Name	Type
request	ICountWorkflowExecutionsRequest

Returns

Promise<CountWorkflowExecutionsResponse>

Type declaration

Name	Type
name	"CountWorkflowExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/CountWorkflowExecutions"
requestStream	undefined
requestType	"CountWorkflowExecutionsRequest"
responseStream	undefined
responseType	"CountWorkflowExecutionsResponse"

---

CountWorkflowExecutionsCallback

Ƭ CountWorkflowExecutionsCallback: (error: Error | null, response?: CountWorkflowExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#countWorkflowExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CountWorkflowExecutionsResponse	CountWorkflowExecutionsResponse

Returns

void

---

CreateSchedule

Ƭ CreateSchedule: Object

Creates a new schedule.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICreateScheduleRequest
callback	CreateScheduleCallback

Returns

void

▸ (request): Promise<CreateScheduleResponse>

Parameters

Name	Type
request	ICreateScheduleRequest

Returns

Promise<CreateScheduleResponse>

Type declaration

Name	Type
name	"CreateSchedule"
path	"/temporal.api.workflowservice.v1.WorkflowService/CreateSchedule"
requestStream	undefined
requestType	"CreateScheduleRequest"
responseStream	undefined
responseType	"CreateScheduleResponse"

---

CreateScheduleCallback

Ƭ CreateScheduleCallback: (error: Error | null, response?: CreateScheduleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#createSchedule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CreateScheduleResponse	CreateScheduleResponse

Returns

void

---

CreateWorkerDeployment

Ƭ CreateWorkerDeployment: Object

Creates a new Worker Deployment.

Experimental. This API might significantly change or be removed in a future release.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICreateWorkerDeploymentRequest
callback	CreateWorkerDeploymentCallback

Returns

void

▸ (request): Promise<CreateWorkerDeploymentResponse>

Parameters

Name	Type
request	ICreateWorkerDeploymentRequest

Returns

Promise<CreateWorkerDeploymentResponse>

Type declaration

Name	Type
name	"CreateWorkerDeployment"
path	"/temporal.api.workflowservice.v1.WorkflowService/CreateWorkerDeployment"
requestStream	undefined
requestType	"CreateWorkerDeploymentRequest"
responseStream	undefined
responseType	"CreateWorkerDeploymentResponse"

---

CreateWorkerDeploymentCallback

Ƭ CreateWorkerDeploymentCallback: (error: Error | null, response?: CreateWorkerDeploymentResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#createWorkerDeployment.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CreateWorkerDeploymentResponse	CreateWorkerDeploymentResponse

Returns

void

---

CreateWorkerDeploymentVersion

Ƭ CreateWorkerDeploymentVersion: Object

Creates a new Worker Deployment Version.

Experimental. This API might significantly change or be removed in a future release.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICreateWorkerDeploymentVersionRequest
callback	CreateWorkerDeploymentVersionCallback

Returns

void

▸ (request): Promise<CreateWorkerDeploymentVersionResponse>

Parameters

Name	Type
request	ICreateWorkerDeploymentVersionRequest

Returns

Promise<CreateWorkerDeploymentVersionResponse>

Type declaration

Name	Type
name	"CreateWorkerDeploymentVersion"
path	"/temporal.api.workflowservice.v1.WorkflowService/CreateWorkerDeploymentVersion"
requestStream	undefined
requestType	"CreateWorkerDeploymentVersionRequest"
responseStream	undefined
responseType	"CreateWorkerDeploymentVersionResponse"

---

CreateWorkerDeploymentVersionCallback

Ƭ CreateWorkerDeploymentVersionCallback: (error: Error | null, response?: CreateWorkerDeploymentVersionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#createWorkerDeploymentVersion.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CreateWorkerDeploymentVersionResponse	CreateWorkerDeploymentVersionResponse

Returns

void

---

CreateWorkflowRule

Ƭ CreateWorkflowRule: Object

Create a new workflow rule. The rules are used to control the workflow execution. The rule will be applied to all running and new workflows in the namespace. If the rule with such ID already exist this call will fail Note: the rules are part of namespace configuration and will be stored in the namespace config. Namespace config is eventually consistent.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICreateWorkflowRuleRequest
callback	CreateWorkflowRuleCallback

Returns

void

▸ (request): Promise<CreateWorkflowRuleResponse>

Parameters

Name	Type
request	ICreateWorkflowRuleRequest

Returns

Promise<CreateWorkflowRuleResponse>

Type declaration

Name	Type
name	"CreateWorkflowRule"
path	"/temporal.api.workflowservice.v1.WorkflowService/CreateWorkflowRule"
requestStream	undefined
requestType	"CreateWorkflowRuleRequest"
responseStream	undefined
responseType	"CreateWorkflowRuleResponse"

---

CreateWorkflowRuleCallback

Ƭ CreateWorkflowRuleCallback: (error: Error | null, response?: CreateWorkflowRuleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#createWorkflowRule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CreateWorkflowRuleResponse	CreateWorkflowRuleResponse

Returns

void

---

DeleteActivityExecution

Ƭ DeleteActivityExecution: Object

DeleteActivityExecution asynchronously deletes a specific activity execution (when ActivityExecution.run_id is provided) or the latest activity execution (when ActivityExecution.run_id is not provided). If the activity Execution is running, it will be terminated before deletion.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Activity deletion not exposed to HTTP, users should use cancel or terminate. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteActivityExecutionRequest
callback	DeleteActivityExecutionCallback

Returns

void

▸ (request): Promise<DeleteActivityExecutionResponse>

Parameters

Name	Type
request	IDeleteActivityExecutionRequest

Returns

Promise<DeleteActivityExecutionResponse>

Type declaration

Name	Type
name	"DeleteActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteActivityExecution"
requestStream	undefined
requestType	"DeleteActivityExecutionRequest"
responseStream	undefined
responseType	"DeleteActivityExecutionResponse"

---

DeleteActivityExecutionCallback

Ƭ DeleteActivityExecutionCallback: (error: Error | null, response?: DeleteActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteActivityExecutionResponse	DeleteActivityExecutionResponse

Returns

void

---

DeleteNexusOperationExecution

Ƭ DeleteNexusOperationExecution: Object

DeleteNexusOperationExecution asynchronously deletes a specific Nexus operation run (when run_id is provided) or the latest run (when run_id is not provided). If the operation is running, it will be terminated before deletion.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Nexus operation deletion not exposed to HTTP, users should use cancel or terminate. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteNexusOperationExecutionRequest
callback	DeleteNexusOperationExecutionCallback

Returns

void

▸ (request): Promise<DeleteNexusOperationExecutionResponse>

Parameters

Name	Type
request	IDeleteNexusOperationExecutionRequest

Returns

Promise<DeleteNexusOperationExecutionResponse>

Type declaration

Name	Type
name	"DeleteNexusOperationExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteNexusOperationExecution"
requestStream	undefined
requestType	"DeleteNexusOperationExecutionRequest"
responseStream	undefined
responseType	"DeleteNexusOperationExecutionResponse"

---

DeleteNexusOperationExecutionCallback

Ƭ DeleteNexusOperationExecutionCallback: (error: Error | null, response?: DeleteNexusOperationExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteNexusOperationExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteNexusOperationExecutionResponse	DeleteNexusOperationExecutionResponse

Returns

void

---

DeleteSchedule

Ƭ DeleteSchedule: Object

Deletes a schedule, removing it from the system.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteScheduleRequest
callback	DeleteScheduleCallback

Returns

void

▸ (request): Promise<DeleteScheduleResponse>

Parameters

Name	Type
request	IDeleteScheduleRequest

Returns

Promise<DeleteScheduleResponse>

Type declaration

Name	Type
name	"DeleteSchedule"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteSchedule"
requestStream	undefined
requestType	"DeleteScheduleRequest"
responseStream	undefined
responseType	"DeleteScheduleResponse"

---

DeleteScheduleCallback

Ƭ DeleteScheduleCallback: (error: Error | null, response?: DeleteScheduleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteSchedule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteScheduleResponse	DeleteScheduleResponse

Returns

void

---

DeleteWorkerDeployment

Ƭ DeleteWorkerDeployment: Object

Deletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteWorkerDeploymentRequest
callback	DeleteWorkerDeploymentCallback

Returns

void

▸ (request): Promise<DeleteWorkerDeploymentResponse>

Parameters

Name	Type
request	IDeleteWorkerDeploymentRequest

Returns

Promise<DeleteWorkerDeploymentResponse>

Type declaration

Name	Type
name	"DeleteWorkerDeployment"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkerDeployment"
requestStream	undefined
requestType	"DeleteWorkerDeploymentRequest"
responseStream	undefined
responseType	"DeleteWorkerDeploymentResponse"

---

DeleteWorkerDeploymentCallback

Ƭ DeleteWorkerDeploymentCallback: (error: Error | null, response?: DeleteWorkerDeploymentResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkerDeployment.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteWorkerDeploymentResponse	DeleteWorkerDeploymentResponse

Returns

void

---

DeleteWorkerDeploymentVersion

Ƭ DeleteWorkerDeploymentVersion: Object

Used for manual deletion of Versions. User can delete a Version only when all the following conditions are met:

• It is not the Current or Ramping Version of its Deployment.
• It has no active pollers (none of the task queues in the Version have pollers)
• It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition can be skipped by passing skip-drainage=true.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteWorkerDeploymentVersionRequest
callback	DeleteWorkerDeploymentVersionCallback

Returns

void

▸ (request): Promise<DeleteWorkerDeploymentVersionResponse>

Parameters

Name	Type
request	IDeleteWorkerDeploymentVersionRequest

Returns

Promise<DeleteWorkerDeploymentVersionResponse>

Type declaration

Name	Type
name	"DeleteWorkerDeploymentVersion"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkerDeploymentVersion"
requestStream	undefined
requestType	"DeleteWorkerDeploymentVersionRequest"
responseStream	undefined
responseType	"DeleteWorkerDeploymentVersionResponse"

---

DeleteWorkerDeploymentVersionCallback

Ƭ DeleteWorkerDeploymentVersionCallback: (error: Error | null, response?: DeleteWorkerDeploymentVersionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkerDeploymentVersion.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteWorkerDeploymentVersionResponse	DeleteWorkerDeploymentVersionResponse

Returns

void

---

DeleteWorkflowExecution

Ƭ DeleteWorkflowExecution: Object

DeleteWorkflowExecution asynchronously deletes a specific Workflow Execution (when WorkflowExecution.run_id is provided) or the latest Workflow Execution (when WorkflowExecution.run_id is not provided). If the Workflow Execution is Running, it will be terminated before deletion.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Workflow deletion not exposed to HTTP, users should use cancel or terminate. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteWorkflowExecutionRequest
callback	DeleteWorkflowExecutionCallback

Returns

void

▸ (request): Promise<DeleteWorkflowExecutionResponse>

Parameters

Name	Type
request	IDeleteWorkflowExecutionRequest

Returns

Promise<DeleteWorkflowExecutionResponse>

Type declaration

Name	Type
name	"DeleteWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkflowExecution"
requestStream	undefined
requestType	"DeleteWorkflowExecutionRequest"
responseStream	undefined
responseType	"DeleteWorkflowExecutionResponse"

---

DeleteWorkflowExecutionCallback

Ƭ DeleteWorkflowExecutionCallback: (error: Error | null, response?: DeleteWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteWorkflowExecutionResponse	DeleteWorkflowExecutionResponse

Returns

void

---

DeleteWorkflowRule

Ƭ DeleteWorkflowRule: Object

Delete rule by rule id

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteWorkflowRuleRequest
callback	DeleteWorkflowRuleCallback

Returns

void

▸ (request): Promise<DeleteWorkflowRuleResponse>

Parameters

Name	Type
request	IDeleteWorkflowRuleRequest

Returns

Promise<DeleteWorkflowRuleResponse>

Type declaration

Name	Type
name	"DeleteWorkflowRule"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkflowRule"
requestStream	undefined
requestType	"DeleteWorkflowRuleRequest"
responseStream	undefined
responseType	"DeleteWorkflowRuleResponse"

---

DeleteWorkflowRuleCallback

Ƭ DeleteWorkflowRuleCallback: (error: Error | null, response?: DeleteWorkflowRuleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkflowRule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteWorkflowRuleResponse	DeleteWorkflowRuleResponse

Returns

void

---

DeprecateNamespace

Ƭ DeprecateNamespace: Object

DeprecateNamespace is used to update the state of a registered namespace to DEPRECATED.

Once the namespace is deprecated it cannot be used to start new workflow executions. Existing workflow executions will continue to run on deprecated namespaces. Deprecated.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Deprecated --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeprecateNamespaceRequest
callback	DeprecateNamespaceCallback

Returns

void

▸ (request): Promise<DeprecateNamespaceResponse>

Parameters

Name	Type
request	IDeprecateNamespaceRequest

Returns

Promise<DeprecateNamespaceResponse>

Type declaration

Name	Type
name	"DeprecateNamespace"
path	"/temporal.api.workflowservice.v1.WorkflowService/DeprecateNamespace"
requestStream	undefined
requestType	"DeprecateNamespaceRequest"
responseStream	undefined
responseType	"DeprecateNamespaceResponse"

---

DeprecateNamespaceCallback

Ƭ DeprecateNamespaceCallback: (error: Error | null, response?: DeprecateNamespaceResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#deprecateNamespace.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeprecateNamespaceResponse	DeprecateNamespaceResponse

Returns

void

---

DescribeActivityExecution

Ƭ DescribeActivityExecution: Object

DescribeActivityExecution returns information about an activity execution. It can be used to:

• Get current activity info without waiting
• Long-poll for next state change and return new activity info Response can optionally include activity input or outcome (if the activity has completed).

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeActivityExecutionRequest
callback	DescribeActivityExecutionCallback

Returns

void

▸ (request): Promise<DescribeActivityExecutionResponse>

Parameters

Name	Type
request	IDescribeActivityExecutionRequest

Returns

Promise<DescribeActivityExecutionResponse>

Type declaration

Name	Type
name	"DescribeActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeActivityExecution"
requestStream	undefined
requestType	"DescribeActivityExecutionRequest"
responseStream	undefined
responseType	"DescribeActivityExecutionResponse"

---

DescribeActivityExecutionCallback

Ƭ DescribeActivityExecutionCallback: (error: Error | null, response?: DescribeActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeActivityExecutionResponse	DescribeActivityExecutionResponse

Returns

void

---

DescribeBatchOperation

Ƭ DescribeBatchOperation: Object

DescribeBatchOperation returns the information about a batch operation

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeBatchOperationRequest
callback	DescribeBatchOperationCallback

Returns

void

▸ (request): Promise<DescribeBatchOperationResponse>

Parameters

Name	Type
request	IDescribeBatchOperationRequest

Returns

Promise<DescribeBatchOperationResponse>

Type declaration

Name	Type
name	"DescribeBatchOperation"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeBatchOperation"
requestStream	undefined
requestType	"DescribeBatchOperationRequest"
responseStream	undefined
responseType	"DescribeBatchOperationResponse"

---

DescribeBatchOperationCallback

Ƭ DescribeBatchOperationCallback: (error: Error | null, response?: DescribeBatchOperationResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeBatchOperation.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeBatchOperationResponse	DescribeBatchOperationResponse

Returns

void

---

DescribeDeployment

Ƭ DescribeDeployment: Object

Describes a worker deployment. Deprecated. Replaced with DescribeWorkerDeploymentVersion.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeDeploymentRequest
callback	DescribeDeploymentCallback

Returns

void

▸ (request): Promise<DescribeDeploymentResponse>

Parameters

Name	Type
request	IDescribeDeploymentRequest

Returns

Promise<DescribeDeploymentResponse>

Type declaration

Name	Type
name	"DescribeDeployment"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeDeployment"
requestStream	undefined
requestType	"DescribeDeploymentRequest"
responseStream	undefined
responseType	"DescribeDeploymentResponse"

---

DescribeDeploymentCallback

Ƭ DescribeDeploymentCallback: (error: Error | null, response?: DescribeDeploymentResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeDeployment.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeDeploymentResponse	DescribeDeploymentResponse

Returns

void

---

DescribeNamespace

Ƭ DescribeNamespace: Object

DescribeNamespace returns the information and configuration for a registered namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeNamespaceRequest
callback	DescribeNamespaceCallback

Returns

void

▸ (request): Promise<DescribeNamespaceResponse>

Parameters

Name	Type
request	IDescribeNamespaceRequest

Returns

Promise<DescribeNamespaceResponse>

Type declaration

Name	Type
name	"DescribeNamespace"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeNamespace"
requestStream	undefined
requestType	"DescribeNamespaceRequest"
responseStream	undefined
responseType	"DescribeNamespaceResponse"

---

DescribeNamespaceCallback

Ƭ DescribeNamespaceCallback: (error: Error | null, response?: DescribeNamespaceResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeNamespace.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeNamespaceResponse	DescribeNamespaceResponse

Returns

void

---

DescribeNexusOperationExecution

Ƭ DescribeNexusOperationExecution: Object

DescribeNexusOperationExecution returns information about a Nexus operation. Supported use cases include:

• Get current operation info without waiting
• Long-poll for next state change and return new operation info Response can optionally include operation input or outcome (if the operation has completed).

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeNexusOperationExecutionRequest
callback	DescribeNexusOperationExecutionCallback

Returns

void

▸ (request): Promise<DescribeNexusOperationExecutionResponse>

Parameters

Name	Type
request	IDescribeNexusOperationExecutionRequest

Returns

Promise<DescribeNexusOperationExecutionResponse>

Type declaration

Name	Type
name	"DescribeNexusOperationExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeNexusOperationExecution"
requestStream	undefined
requestType	"DescribeNexusOperationExecutionRequest"
responseStream	undefined
responseType	"DescribeNexusOperationExecutionResponse"

---

DescribeNexusOperationExecutionCallback

Ƭ DescribeNexusOperationExecutionCallback: (error: Error | null, response?: DescribeNexusOperationExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeNexusOperationExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeNexusOperationExecutionResponse	DescribeNexusOperationExecutionResponse

Returns

void

---

DescribeSchedule

Ƭ DescribeSchedule: Object

Returns the schedule description and current state of an existing schedule.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeScheduleRequest
callback	DescribeScheduleCallback

Returns

void

▸ (request): Promise<DescribeScheduleResponse>

Parameters

Name	Type
request	IDescribeScheduleRequest

Returns

Promise<DescribeScheduleResponse>

Type declaration

Name	Type
name	"DescribeSchedule"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeSchedule"
requestStream	undefined
requestType	"DescribeScheduleRequest"
responseStream	undefined
responseType	"DescribeScheduleResponse"

---

DescribeScheduleCallback

Ƭ DescribeScheduleCallback: (error: Error | null, response?: DescribeScheduleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeSchedule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeScheduleResponse	DescribeScheduleResponse

Returns

void

---

DescribeTaskQueue

Ƭ DescribeTaskQueue: Object

DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:

• List of pollers
• Workflow Reachability status
• Backlog info for Workflow and/or Activity tasks

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeTaskQueueRequest
callback	DescribeTaskQueueCallback

Returns

void

▸ (request): Promise<DescribeTaskQueueResponse>

Parameters

Name	Type
request	IDescribeTaskQueueRequest

Returns

Promise<DescribeTaskQueueResponse>

Type declaration

Name	Type
name	"DescribeTaskQueue"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeTaskQueue"
requestStream	undefined
requestType	"DescribeTaskQueueRequest"
responseStream	undefined
responseType	"DescribeTaskQueueResponse"

---

DescribeTaskQueueCallback

Ƭ DescribeTaskQueueCallback: (error: Error | null, response?: DescribeTaskQueueResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeTaskQueue.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeTaskQueueResponse	DescribeTaskQueueResponse

Returns

void

---

DescribeWorker

Ƭ DescribeWorker: Object

DescribeWorker returns information about the specified worker.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeWorkerRequest
callback	DescribeWorkerCallback

Returns

void

▸ (request): Promise<DescribeWorkerResponse>

Parameters

Name	Type
request	IDescribeWorkerRequest

Returns

Promise<DescribeWorkerResponse>

Type declaration

Name	Type
name	"DescribeWorker"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeWorker"
requestStream	undefined
requestType	"DescribeWorkerRequest"
responseStream	undefined
responseType	"DescribeWorkerResponse"

---

DescribeWorkerCallback

Ƭ DescribeWorkerCallback: (error: Error | null, response?: DescribeWorkerResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorker.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeWorkerResponse	DescribeWorkerResponse

Returns

void

---

DescribeWorkerDeployment

Ƭ DescribeWorkerDeployment: Object

Describes a Worker Deployment.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeWorkerDeploymentRequest
callback	DescribeWorkerDeploymentCallback

Returns

void

▸ (request): Promise<DescribeWorkerDeploymentResponse>

Parameters

Name	Type
request	IDescribeWorkerDeploymentRequest

Returns

Promise<DescribeWorkerDeploymentResponse>

Type declaration

Name	Type
name	"DescribeWorkerDeployment"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkerDeployment"
requestStream	undefined
requestType	"DescribeWorkerDeploymentRequest"
responseStream	undefined
responseType	"DescribeWorkerDeploymentResponse"

---

DescribeWorkerDeploymentCallback

Ƭ DescribeWorkerDeploymentCallback: (error: Error | null, response?: DescribeWorkerDeploymentResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkerDeployment.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeWorkerDeploymentResponse	DescribeWorkerDeploymentResponse

Returns

void

---

DescribeWorkerDeploymentVersion

Ƭ DescribeWorkerDeploymentVersion: Object

Describes a worker deployment version.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeWorkerDeploymentVersionRequest
callback	DescribeWorkerDeploymentVersionCallback

Returns

void

▸ (request): Promise<DescribeWorkerDeploymentVersionResponse>

Parameters

Name	Type
request	IDescribeWorkerDeploymentVersionRequest

Returns

Promise<DescribeWorkerDeploymentVersionResponse>

Type declaration

Name	Type
name	"DescribeWorkerDeploymentVersion"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkerDeploymentVersion"
requestStream	undefined
requestType	"DescribeWorkerDeploymentVersionRequest"
responseStream	undefined
responseType	"DescribeWorkerDeploymentVersionResponse"

---

DescribeWorkerDeploymentVersionCallback

Ƭ DescribeWorkerDeploymentVersionCallback: (error: Error | null, response?: DescribeWorkerDeploymentVersionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkerDeploymentVersion.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeWorkerDeploymentVersionResponse	DescribeWorkerDeploymentVersionResponse

Returns

void

---

DescribeWorkflowExecution

Ƭ DescribeWorkflowExecution: Object

DescribeWorkflowExecution returns information about the specified workflow execution.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeWorkflowExecutionRequest
callback	DescribeWorkflowExecutionCallback

Returns

void

▸ (request): Promise<DescribeWorkflowExecutionResponse>

Parameters

Name	Type
request	IDescribeWorkflowExecutionRequest

Returns

Promise<DescribeWorkflowExecutionResponse>

Type declaration

Name	Type
name	"DescribeWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkflowExecution"
requestStream	undefined
requestType	"DescribeWorkflowExecutionRequest"
responseStream	undefined
responseType	"DescribeWorkflowExecutionResponse"

---

DescribeWorkflowExecutionCallback

Ƭ DescribeWorkflowExecutionCallback: (error: Error | null, response?: DescribeWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeWorkflowExecutionResponse	DescribeWorkflowExecutionResponse

Returns

void

---

DescribeWorkflowRule

Ƭ DescribeWorkflowRule: Object

DescribeWorkflowRule return the rule specification for existing rule id. If there is no rule with such id - NOT FOUND error will be returned.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDescribeWorkflowRuleRequest
callback	DescribeWorkflowRuleCallback

Returns

void

▸ (request): Promise<DescribeWorkflowRuleResponse>

Parameters

Name	Type
request	IDescribeWorkflowRuleRequest

Returns

Promise<DescribeWorkflowRuleResponse>

Type declaration

Name	Type
name	"DescribeWorkflowRule"
path	"/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkflowRule"
requestStream	undefined
requestType	"DescribeWorkflowRuleRequest"
responseStream	undefined
responseType	"DescribeWorkflowRuleResponse"

---

DescribeWorkflowRuleCallback

Ƭ DescribeWorkflowRuleCallback: (error: Error | null, response?: DescribeWorkflowRuleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkflowRule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DescribeWorkflowRuleResponse	DescribeWorkflowRuleResponse

Returns

void

---

ExecuteMultiOperation

Ƭ ExecuteMultiOperation: Object

ExecuteMultiOperation executes multiple operations within a single workflow.

Operations are started atomically, meaning if any operation fails to be started, none are, and the request fails. Upon start, the API returns only when all operations have a response.

Upon failure, it returns MultiOperationExecutionFailure where the status code equals the status code of the first operation that failed to be started.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: To be exposed over HTTP in the future. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IExecuteMultiOperationRequest
callback	ExecuteMultiOperationCallback

Returns

void

▸ (request): Promise<ExecuteMultiOperationResponse>

Parameters

Name	Type
request	IExecuteMultiOperationRequest

Returns

Promise<ExecuteMultiOperationResponse>

Type declaration

Name	Type
name	"ExecuteMultiOperation"
path	"/temporal.api.workflowservice.v1.WorkflowService/ExecuteMultiOperation"
requestStream	undefined
requestType	"ExecuteMultiOperationRequest"
responseStream	undefined
responseType	"ExecuteMultiOperationResponse"

---

ExecuteMultiOperationCallback

Ƭ ExecuteMultiOperationCallback: (error: Error | null, response?: ExecuteMultiOperationResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#executeMultiOperation.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ExecuteMultiOperationResponse	ExecuteMultiOperationResponse

Returns

void

---

FetchWorkerConfig

Ƭ FetchWorkerConfig: Object

FetchWorkerConfig returns the worker configuration for a specific worker.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IFetchWorkerConfigRequest
callback	FetchWorkerConfigCallback

Returns

void

▸ (request): Promise<FetchWorkerConfigResponse>

Parameters

Name	Type
request	IFetchWorkerConfigRequest

Returns

Promise<FetchWorkerConfigResponse>

Type declaration

Name	Type
name	"FetchWorkerConfig"
path	"/temporal.api.workflowservice.v1.WorkflowService/FetchWorkerConfig"
requestStream	undefined
requestType	"FetchWorkerConfigRequest"
responseStream	undefined
responseType	"FetchWorkerConfigResponse"

---

FetchWorkerConfigCallback

Ƭ FetchWorkerConfigCallback: (error: Error | null, response?: FetchWorkerConfigResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#fetchWorkerConfig.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	FetchWorkerConfigResponse	FetchWorkerConfigResponse

Returns

void

---

GetClusterInfo

Ƭ GetClusterInfo: Object

GetClusterInfo returns information about temporal cluster

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetClusterInfoRequest
callback	GetClusterInfoCallback

Returns

void

▸ (request): Promise<GetClusterInfoResponse>

Parameters

Name	Type
request	IGetClusterInfoRequest

Returns

Promise<GetClusterInfoResponse>

Type declaration

Name	Type
name	"GetClusterInfo"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetClusterInfo"
requestStream	undefined
requestType	"GetClusterInfoRequest"
responseStream	undefined
responseType	"GetClusterInfoResponse"

---

GetClusterInfoCallback

Ƭ GetClusterInfoCallback: (error: Error | null, response?: GetClusterInfoResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getClusterInfo.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetClusterInfoResponse	GetClusterInfoResponse

Returns

void

---

GetCurrentDeployment

Ƭ GetCurrentDeployment: Object

Returns the current deployment (and its info) for a given deployment series. Deprecated. Replaced by current_version returned by DescribeWorkerDeployment.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetCurrentDeploymentRequest
callback	GetCurrentDeploymentCallback

Returns

void

▸ (request): Promise<GetCurrentDeploymentResponse>

Parameters

Name	Type
request	IGetCurrentDeploymentRequest

Returns

Promise<GetCurrentDeploymentResponse>

Type declaration

Name	Type
name	"GetCurrentDeployment"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetCurrentDeployment"
requestStream	undefined
requestType	"GetCurrentDeploymentRequest"
responseStream	undefined
responseType	"GetCurrentDeploymentResponse"

---

GetCurrentDeploymentCallback

Ƭ GetCurrentDeploymentCallback: (error: Error | null, response?: GetCurrentDeploymentResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getCurrentDeployment.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetCurrentDeploymentResponse	GetCurrentDeploymentResponse

Returns

void

---

GetDeploymentReachability

Ƭ GetDeploymentReachability: Object

Returns the reachability level of a worker deployment to help users decide when it is time to decommission a deployment. Reachability level is calculated based on the deployment's status and existing workflows that depend on the given deployment for their execution. Calculating reachability is relatively expensive. Therefore, server might return a recently cached value. In such a case, the last_update_time will inform you about the actual reachability calculation time. Deprecated. Replaced with DrainageInfo returned by DescribeWorkerDeploymentVersion.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetDeploymentReachabilityRequest
callback	GetDeploymentReachabilityCallback

Returns

void

▸ (request): Promise<GetDeploymentReachabilityResponse>

Parameters

Name	Type
request	IGetDeploymentReachabilityRequest

Returns

Promise<GetDeploymentReachabilityResponse>

Type declaration

Name	Type
name	"GetDeploymentReachability"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetDeploymentReachability"
requestStream	undefined
requestType	"GetDeploymentReachabilityRequest"
responseStream	undefined
responseType	"GetDeploymentReachabilityResponse"

---

GetDeploymentReachabilityCallback

Ƭ GetDeploymentReachabilityCallback: (error: Error | null, response?: GetDeploymentReachabilityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getDeploymentReachability.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetDeploymentReachabilityResponse	GetDeploymentReachabilityResponse

Returns

void

---

GetSearchAttributes

Ƭ GetSearchAttributes: Object

GetSearchAttributes is a visibility API to get all legal keys that could be used in list APIs

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose this search attribute API to HTTP (but may expose on OperatorService). --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetSearchAttributesRequest
callback	GetSearchAttributesCallback

Returns

void

▸ (request): Promise<GetSearchAttributesResponse>

Parameters

Name	Type
request	IGetSearchAttributesRequest

Returns

Promise<GetSearchAttributesResponse>

Type declaration

Name	Type
name	"GetSearchAttributes"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetSearchAttributes"
requestStream	undefined
requestType	"GetSearchAttributesRequest"
responseStream	undefined
responseType	"GetSearchAttributesResponse"

---

GetSearchAttributesCallback

Ƭ GetSearchAttributesCallback: (error: Error | null, response?: GetSearchAttributesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getSearchAttributes.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetSearchAttributesResponse	GetSearchAttributesResponse

Returns

void

---

GetSystemInfo

Ƭ GetSystemInfo: Object

GetSystemInfo returns information about the system.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetSystemInfoRequest
callback	GetSystemInfoCallback

Returns

void

▸ (request): Promise<GetSystemInfoResponse>

Parameters

Name	Type
request	IGetSystemInfoRequest

Returns

Promise<GetSystemInfoResponse>

Type declaration

Name	Type
name	"GetSystemInfo"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetSystemInfo"
requestStream	undefined
requestType	"GetSystemInfoRequest"
responseStream	undefined
responseType	"GetSystemInfoResponse"

---

GetSystemInfoCallback

Ƭ GetSystemInfoCallback: (error: Error | null, response?: GetSystemInfoResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getSystemInfo.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetSystemInfoResponse	GetSystemInfoResponse

Returns

void

---

GetWorkerBuildIdCompatibility

Ƭ GetWorkerBuildIdCompatibility: Object

Deprecated. Use GetWorkerVersioningRules. Will be removed in server version v1.32.0. Fetches the worker build id versioning sets for a task queue.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetWorkerBuildIdCompatibilityRequest
callback	GetWorkerBuildIdCompatibilityCallback

Returns

void

▸ (request): Promise<GetWorkerBuildIdCompatibilityResponse>

Parameters

Name	Type
request	IGetWorkerBuildIdCompatibilityRequest

Returns

Promise<GetWorkerBuildIdCompatibilityResponse>

Type declaration

Name	Type
name	"GetWorkerBuildIdCompatibility"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetWorkerBuildIdCompatibility"
requestStream	undefined
requestType	"GetWorkerBuildIdCompatibilityRequest"
responseStream	undefined
responseType	"GetWorkerBuildIdCompatibilityResponse"

---

GetWorkerBuildIdCompatibilityCallback

Ƭ GetWorkerBuildIdCompatibilityCallback: (error: Error | null, response?: GetWorkerBuildIdCompatibilityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkerBuildIdCompatibility.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetWorkerBuildIdCompatibilityResponse	GetWorkerBuildIdCompatibilityResponse

Returns

void

---

GetWorkerTaskReachability

Ƭ GetWorkerTaskReachability: Object

Deprecated. Use DescribeTaskQueue. Will be removed in server version v1.32.0.

Fetches task reachability to determine whether a worker may be retired. The request may specify task queues to query for or let the server fetch all task queues mapped to the given build IDs.

When requesting a large number of task queues or all task queues associated with the given build ids in a namespace, all task queues will be listed in the response but some of them may not contain reachability information due to a server enforced limit. When reaching the limit, task queues that reachability information could not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue another call to get the reachability for those task queues.

Open source users can adjust this limit by setting the server's dynamic config value for limit.reachabilityTaskQueueScan with the caveat that this call can strain the visibility store.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetWorkerTaskReachabilityRequest
callback	GetWorkerTaskReachabilityCallback

Returns

void

▸ (request): Promise<GetWorkerTaskReachabilityResponse>

Parameters

Name	Type
request	IGetWorkerTaskReachabilityRequest

Returns

Promise<GetWorkerTaskReachabilityResponse>

Type declaration

Name	Type
name	"GetWorkerTaskReachability"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetWorkerTaskReachability"
requestStream	undefined
requestType	"GetWorkerTaskReachabilityRequest"
responseStream	undefined
responseType	"GetWorkerTaskReachabilityResponse"

---

GetWorkerTaskReachabilityCallback

Ƭ GetWorkerTaskReachabilityCallback: (error: Error | null, response?: GetWorkerTaskReachabilityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkerTaskReachability.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetWorkerTaskReachabilityResponse	GetWorkerTaskReachabilityResponse

Returns

void

---

GetWorkerVersioningRules

Ƭ GetWorkerVersioningRules: Object

Fetches the Build ID assignment and redirect rules for a Task Queue. Will be removed in server version v1.32.0.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetWorkerVersioningRulesRequest
callback	GetWorkerVersioningRulesCallback

Returns

void

▸ (request): Promise<GetWorkerVersioningRulesResponse>

Parameters

Name	Type
request	IGetWorkerVersioningRulesRequest

Returns

Promise<GetWorkerVersioningRulesResponse>

Type declaration

Name	Type
name	"GetWorkerVersioningRules"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetWorkerVersioningRules"
requestStream	undefined
requestType	"GetWorkerVersioningRulesRequest"
responseStream	undefined
responseType	"GetWorkerVersioningRulesResponse"

---

GetWorkerVersioningRulesCallback

Ƭ GetWorkerVersioningRulesCallback: (error: Error | null, response?: GetWorkerVersioningRulesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkerVersioningRules.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetWorkerVersioningRulesResponse	GetWorkerVersioningRulesResponse

Returns

void

---

GetWorkflowExecutionHistory

Ƭ GetWorkflowExecutionHistory: Object

GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with NotFound if the specified workflow execution is unknown to the service.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetWorkflowExecutionHistoryRequest
callback	GetWorkflowExecutionHistoryCallback

Returns

void

▸ (request): Promise<GetWorkflowExecutionHistoryResponse>

Parameters

Name	Type
request	IGetWorkflowExecutionHistoryRequest

Returns

Promise<GetWorkflowExecutionHistoryResponse>

Type declaration

Name	Type
name	"GetWorkflowExecutionHistory"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetWorkflowExecutionHistory"
requestStream	undefined
requestType	"GetWorkflowExecutionHistoryRequest"
responseStream	undefined
responseType	"GetWorkflowExecutionHistoryResponse"

---

GetWorkflowExecutionHistoryCallback

Ƭ GetWorkflowExecutionHistoryCallback: (error: Error | null, response?: GetWorkflowExecutionHistoryResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkflowExecutionHistory.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetWorkflowExecutionHistoryResponse	GetWorkflowExecutionHistoryResponse

Returns

void

---

GetWorkflowExecutionHistoryReverse

Ƭ GetWorkflowExecutionHistoryReverse: Object

GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse order (starting from last event). Fails withNotFound if the specified workflow execution is unknown to the service.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetWorkflowExecutionHistoryReverseRequest
callback	GetWorkflowExecutionHistoryReverseCallback

Returns

void

▸ (request): Promise<GetWorkflowExecutionHistoryReverseResponse>

Parameters

Name	Type
request	IGetWorkflowExecutionHistoryReverseRequest

Returns

Promise<GetWorkflowExecutionHistoryReverseResponse>

Type declaration

Name	Type
name	"GetWorkflowExecutionHistoryReverse"
path	"/temporal.api.workflowservice.v1.WorkflowService/GetWorkflowExecutionHistoryReverse"
requestStream	undefined
requestType	"GetWorkflowExecutionHistoryReverseRequest"
responseStream	undefined
responseType	"GetWorkflowExecutionHistoryReverseResponse"

---

GetWorkflowExecutionHistoryReverseCallback

Ƭ GetWorkflowExecutionHistoryReverseCallback: (error: Error | null, response?: GetWorkflowExecutionHistoryReverseResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkflowExecutionHistoryReverse.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetWorkflowExecutionHistoryReverseResponse	GetWorkflowExecutionHistoryReverseResponse

Returns

void

---

ListActivityExecutions

Ƭ ListActivityExecutions: Object

ListActivityExecutions is a visibility API to list activity executions in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListActivityExecutionsRequest
callback	ListActivityExecutionsCallback

Returns

void

▸ (request): Promise<ListActivityExecutionsResponse>

Parameters

Name	Type
request	IListActivityExecutionsRequest

Returns

Promise<ListActivityExecutionsResponse>

Type declaration

Name	Type
name	"ListActivityExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListActivityExecutions"
requestStream	undefined
requestType	"ListActivityExecutionsRequest"
responseStream	undefined
responseType	"ListActivityExecutionsResponse"

---

ListActivityExecutionsCallback

Ƭ ListActivityExecutionsCallback: (error: Error | null, response?: ListActivityExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listActivityExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListActivityExecutionsResponse	ListActivityExecutionsResponse

Returns

void

---

ListArchivedWorkflowExecutions

Ƭ ListArchivedWorkflowExecutions: Object

ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListArchivedWorkflowExecutionsRequest
callback	ListArchivedWorkflowExecutionsCallback

Returns

void

▸ (request): Promise<ListArchivedWorkflowExecutionsResponse>

Parameters

Name	Type
request	IListArchivedWorkflowExecutionsRequest

Returns

Promise<ListArchivedWorkflowExecutionsResponse>

Type declaration

Name	Type
name	"ListArchivedWorkflowExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListArchivedWorkflowExecutions"
requestStream	undefined
requestType	"ListArchivedWorkflowExecutionsRequest"
responseStream	undefined
responseType	"ListArchivedWorkflowExecutionsResponse"

---

ListArchivedWorkflowExecutionsCallback

Ƭ ListArchivedWorkflowExecutionsCallback: (error: Error | null, response?: ListArchivedWorkflowExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listArchivedWorkflowExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListArchivedWorkflowExecutionsResponse	ListArchivedWorkflowExecutionsResponse

Returns

void

---

ListBatchOperations

Ƭ ListBatchOperations: Object

ListBatchOperations returns a list of batch operations

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListBatchOperationsRequest
callback	ListBatchOperationsCallback

Returns

void

▸ (request): Promise<ListBatchOperationsResponse>

Parameters

Name	Type
request	IListBatchOperationsRequest

Returns

Promise<ListBatchOperationsResponse>

Type declaration

Name	Type
name	"ListBatchOperations"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListBatchOperations"
requestStream	undefined
requestType	"ListBatchOperationsRequest"
responseStream	undefined
responseType	"ListBatchOperationsResponse"

---

ListBatchOperationsCallback

Ƭ ListBatchOperationsCallback: (error: Error | null, response?: ListBatchOperationsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listBatchOperations.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListBatchOperationsResponse	ListBatchOperationsResponse

Returns

void

---

ListClosedWorkflowExecutions

Ƭ ListClosedWorkflowExecutions: Object

ListClosedWorkflowExecutions is a visibility API to list the closed executions in a specific namespace.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListClosedWorkflowExecutionsRequest
callback	ListClosedWorkflowExecutionsCallback

Returns

void

▸ (request): Promise<ListClosedWorkflowExecutionsResponse>

Parameters

Name	Type
request	IListClosedWorkflowExecutionsRequest

Returns

Promise<ListClosedWorkflowExecutionsResponse>

Type declaration

Name	Type
name	"ListClosedWorkflowExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListClosedWorkflowExecutions"
requestStream	undefined
requestType	"ListClosedWorkflowExecutionsRequest"
responseStream	undefined
responseType	"ListClosedWorkflowExecutionsResponse"

---

ListClosedWorkflowExecutionsCallback

Ƭ ListClosedWorkflowExecutionsCallback: (error: Error | null, response?: ListClosedWorkflowExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listClosedWorkflowExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListClosedWorkflowExecutionsResponse	ListClosedWorkflowExecutionsResponse

Returns

void

---

ListDeployments

Ƭ ListDeployments: Object

Lists worker deployments in the namespace. Optionally can filter based on deployment series name. Deprecated. Replaced with ListWorkerDeployments.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListDeploymentsRequest
callback	ListDeploymentsCallback

Returns

void

▸ (request): Promise<ListDeploymentsResponse>

Parameters

Name	Type
request	IListDeploymentsRequest

Returns

Promise<ListDeploymentsResponse>

Type declaration

Name	Type
name	"ListDeployments"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListDeployments"
requestStream	undefined
requestType	"ListDeploymentsRequest"
responseStream	undefined
responseType	"ListDeploymentsResponse"

---

ListDeploymentsCallback

Ƭ ListDeploymentsCallback: (error: Error | null, response?: ListDeploymentsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listDeployments.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListDeploymentsResponse	ListDeploymentsResponse

Returns

void

---

ListNamespaces

Ƭ ListNamespaces: Object

ListNamespaces returns the information and configuration for all namespaces.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListNamespacesRequest
callback	ListNamespacesCallback

Returns

void

▸ (request): Promise<ListNamespacesResponse>

Parameters

Name	Type
request	IListNamespacesRequest

Returns

Promise<ListNamespacesResponse>

Type declaration

Name	Type
name	"ListNamespaces"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListNamespaces"
requestStream	undefined
requestType	"ListNamespacesRequest"
responseStream	undefined
responseType	"ListNamespacesResponse"

---

ListNamespacesCallback

Ƭ ListNamespacesCallback: (error: Error | null, response?: ListNamespacesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listNamespaces.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListNamespacesResponse	ListNamespacesResponse

Returns

void

---

ListNexusOperationExecutions

Ƭ ListNexusOperationExecutions: Object

ListNexusOperationExecutions is a visibility API to list Nexus operations in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListNexusOperationExecutionsRequest
callback	ListNexusOperationExecutionsCallback

Returns

void

▸ (request): Promise<ListNexusOperationExecutionsResponse>

Parameters

Name	Type
request	IListNexusOperationExecutionsRequest

Returns

Promise<ListNexusOperationExecutionsResponse>

Type declaration

Name	Type
name	"ListNexusOperationExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListNexusOperationExecutions"
requestStream	undefined
requestType	"ListNexusOperationExecutionsRequest"
responseStream	undefined
responseType	"ListNexusOperationExecutionsResponse"

---

ListNexusOperationExecutionsCallback

Ƭ ListNexusOperationExecutionsCallback: (error: Error | null, response?: ListNexusOperationExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listNexusOperationExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListNexusOperationExecutionsResponse	ListNexusOperationExecutionsResponse

Returns

void

---

ListOpenWorkflowExecutions

Ƭ ListOpenWorkflowExecutions: Object

ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific namespace.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListOpenWorkflowExecutionsRequest
callback	ListOpenWorkflowExecutionsCallback

Returns

void

▸ (request): Promise<ListOpenWorkflowExecutionsResponse>

Parameters

Name	Type
request	IListOpenWorkflowExecutionsRequest

Returns

Promise<ListOpenWorkflowExecutionsResponse>

Type declaration

Name	Type
name	"ListOpenWorkflowExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListOpenWorkflowExecutions"
requestStream	undefined
requestType	"ListOpenWorkflowExecutionsRequest"
responseStream	undefined
responseType	"ListOpenWorkflowExecutionsResponse"

---

ListOpenWorkflowExecutionsCallback

Ƭ ListOpenWorkflowExecutionsCallback: (error: Error | null, response?: ListOpenWorkflowExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listOpenWorkflowExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListOpenWorkflowExecutionsResponse	ListOpenWorkflowExecutionsResponse

Returns

void

---

ListScheduleMatchingTimes

Ƭ ListScheduleMatchingTimes: Object

Lists matching times within a range.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListScheduleMatchingTimesRequest
callback	ListScheduleMatchingTimesCallback

Returns

void

▸ (request): Promise<ListScheduleMatchingTimesResponse>

Parameters

Name	Type
request	IListScheduleMatchingTimesRequest

Returns

Promise<ListScheduleMatchingTimesResponse>

Type declaration

Name	Type
name	"ListScheduleMatchingTimes"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListScheduleMatchingTimes"
requestStream	undefined
requestType	"ListScheduleMatchingTimesRequest"
responseStream	undefined
responseType	"ListScheduleMatchingTimesResponse"

---

ListScheduleMatchingTimesCallback

Ƭ ListScheduleMatchingTimesCallback: (error: Error | null, response?: ListScheduleMatchingTimesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listScheduleMatchingTimes.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListScheduleMatchingTimesResponse	ListScheduleMatchingTimesResponse

Returns

void

---

ListSchedules

Ƭ ListSchedules: Object

List all schedules in a namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListSchedulesRequest
callback	ListSchedulesCallback

Returns

void

▸ (request): Promise<ListSchedulesResponse>

Parameters

Name	Type
request	IListSchedulesRequest

Returns

Promise<ListSchedulesResponse>

Type declaration

Name	Type
name	"ListSchedules"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListSchedules"
requestStream	undefined
requestType	"ListSchedulesRequest"
responseStream	undefined
responseType	"ListSchedulesResponse"

---

ListSchedulesCallback

Ƭ ListSchedulesCallback: (error: Error | null, response?: ListSchedulesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listSchedules.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListSchedulesResponse	ListSchedulesResponse

Returns

void

---

ListTaskQueuePartitions

Ƭ ListTaskQueuePartitions: Object

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose this low-level API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListTaskQueuePartitionsRequest
callback	ListTaskQueuePartitionsCallback

Returns

void

▸ (request): Promise<ListTaskQueuePartitionsResponse>

Parameters

Name	Type
request	IListTaskQueuePartitionsRequest

Returns

Promise<ListTaskQueuePartitionsResponse>

Type declaration

Name	Type
name	"ListTaskQueuePartitions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListTaskQueuePartitions"
requestStream	undefined
requestType	"ListTaskQueuePartitionsRequest"
responseStream	undefined
responseType	"ListTaskQueuePartitionsResponse"

---

ListTaskQueuePartitionsCallback

Ƭ ListTaskQueuePartitionsCallback: (error: Error | null, response?: ListTaskQueuePartitionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listTaskQueuePartitions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListTaskQueuePartitionsResponse	ListTaskQueuePartitionsResponse

Returns

void

---

ListWorkerDeployments

Ƭ ListWorkerDeployments: Object

Lists all Worker Deployments that are tracked in the Namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListWorkerDeploymentsRequest
callback	ListWorkerDeploymentsCallback

Returns

void

▸ (request): Promise<ListWorkerDeploymentsResponse>

Parameters

Name	Type
request	IListWorkerDeploymentsRequest

Returns

Promise<ListWorkerDeploymentsResponse>

Type declaration

Name	Type
name	"ListWorkerDeployments"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListWorkerDeployments"
requestStream	undefined
requestType	"ListWorkerDeploymentsRequest"
responseStream	undefined
responseType	"ListWorkerDeploymentsResponse"

---

ListWorkerDeploymentsCallback

Ƭ ListWorkerDeploymentsCallback: (error: Error | null, response?: ListWorkerDeploymentsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkerDeployments.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListWorkerDeploymentsResponse	ListWorkerDeploymentsResponse

Returns

void

---

ListWorkers

Ƭ ListWorkers: Object

ListWorkers is a visibility API to list worker status information in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListWorkersRequest
callback	ListWorkersCallback

Returns

void

▸ (request): Promise<ListWorkersResponse>

Parameters

Name	Type
request	IListWorkersRequest

Returns

Promise<ListWorkersResponse>

Type declaration

Name	Type
name	"ListWorkers"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListWorkers"
requestStream	undefined
requestType	"ListWorkersRequest"
responseStream	undefined
responseType	"ListWorkersResponse"

---

ListWorkersCallback

Ƭ ListWorkersCallback: (error: Error | null, response?: ListWorkersResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkers.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListWorkersResponse	ListWorkersResponse

Returns

void

---

ListWorkflowExecutions

Ƭ ListWorkflowExecutions: Object

ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListWorkflowExecutionsRequest
callback	ListWorkflowExecutionsCallback

Returns

void

▸ (request): Promise<ListWorkflowExecutionsResponse>

Parameters

Name	Type
request	IListWorkflowExecutionsRequest

Returns

Promise<ListWorkflowExecutionsResponse>

Type declaration

Name	Type
name	"ListWorkflowExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListWorkflowExecutions"
requestStream	undefined
requestType	"ListWorkflowExecutionsRequest"
responseStream	undefined
responseType	"ListWorkflowExecutionsResponse"

---

ListWorkflowExecutionsCallback

Ƭ ListWorkflowExecutionsCallback: (error: Error | null, response?: ListWorkflowExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkflowExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListWorkflowExecutionsResponse	ListWorkflowExecutionsResponse

Returns

void

---

ListWorkflowRules

Ƭ ListWorkflowRules: Object

Return all namespace workflow rules

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListWorkflowRulesRequest
callback	ListWorkflowRulesCallback

Returns

void

▸ (request): Promise<ListWorkflowRulesResponse>

Parameters

Name	Type
request	IListWorkflowRulesRequest

Returns

Promise<ListWorkflowRulesResponse>

Type declaration

Name	Type
name	"ListWorkflowRules"
path	"/temporal.api.workflowservice.v1.WorkflowService/ListWorkflowRules"
requestStream	undefined
requestType	"ListWorkflowRulesRequest"
responseStream	undefined
responseType	"ListWorkflowRulesResponse"

---

ListWorkflowRulesCallback

Ƭ ListWorkflowRulesCallback: (error: Error | null, response?: ListWorkflowRulesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkflowRules.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListWorkflowRulesResponse	ListWorkflowRulesResponse

Returns

void

---

PatchSchedule

Ƭ PatchSchedule: Object

Makes a specific change to a schedule or triggers an immediate action.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPatchScheduleRequest
callback	PatchScheduleCallback

Returns

void

▸ (request): Promise<PatchScheduleResponse>

Parameters

Name	Type
request	IPatchScheduleRequest

Returns

Promise<PatchScheduleResponse>

Type declaration

Name	Type
name	"PatchSchedule"
path	"/temporal.api.workflowservice.v1.WorkflowService/PatchSchedule"
requestStream	undefined
requestType	"PatchScheduleRequest"
responseStream	undefined
responseType	"PatchScheduleResponse"

---

PatchScheduleCallback

Ƭ PatchScheduleCallback: (error: Error | null, response?: PatchScheduleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#patchSchedule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PatchScheduleResponse	PatchScheduleResponse

Returns

void

---

PauseActivity

Ƭ PauseActivity: Object

PauseActivity pauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them will be paused

Pausing an activity means:

• If the activity is currently waiting for a retry or is running and subsequently fails, it will not be rescheduled until it is unpaused.
• If the activity is already paused, calling this method will have no effect.
• If the activity is running and finishes successfully, the activity will be completed.
• If the activity is running and finishes with failure:

• if there is no retry left - the activity will be completed.
• if there are more retries left - the activity will be paused. For long-running activities:

• activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'.
• The activity should respond to the cancellation accordingly.

Returns a NotFound error if there is no pending activity with the provided ID or type This API will be deprecated soon and replaced with a newer PauseActivityExecution that is better named and structured to work well for standalone activities.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPauseActivityRequest
callback	PauseActivityCallback

Returns

void

▸ (request): Promise<PauseActivityResponse>

Parameters

Name	Type
request	IPauseActivityRequest

Returns

Promise<PauseActivityResponse>

Type declaration

Name	Type
name	"PauseActivity"
path	"/temporal.api.workflowservice.v1.WorkflowService/PauseActivity"
requestStream	undefined
requestType	"PauseActivityRequest"
responseStream	undefined
responseType	"PauseActivityResponse"

---

PauseActivityCallback

Ƭ PauseActivityCallback: (error: Error | null, response?: PauseActivityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pauseActivity.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PauseActivityResponse	PauseActivityResponse

Returns

void

---

PauseActivityExecution

Ƭ PauseActivityExecution: Object

PauseActivityExecution pauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity

Pausing an activity means:

• If the activity is currently waiting for a retry or is running and subsequently fails, it will not be rescheduled until it is unpaused.
• If the activity is already paused, calling this method will have no effect.
• If the activity is running and finishes successfully, the activity will be completed.
• If the activity is running and finishes with failure:

• if there is no retry left - the activity will be completed.
• if there are more retries left - the activity will be paused. For long-running activities:

• activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'.

Returns a NotFound error if there is no pending activity with the provided ID

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPauseActivityExecutionRequest
callback	PauseActivityExecutionCallback

Returns

void

▸ (request): Promise<PauseActivityExecutionResponse>

Parameters

Name	Type
request	IPauseActivityExecutionRequest

Returns

Promise<PauseActivityExecutionResponse>

Type declaration

Name	Type
name	"PauseActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/PauseActivityExecution"
requestStream	undefined
requestType	"PauseActivityExecutionRequest"
responseStream	undefined
responseType	"PauseActivityExecutionResponse"

---

PauseActivityExecutionCallback

Ƭ PauseActivityExecutionCallback: (error: Error | null, response?: PauseActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pauseActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PauseActivityExecutionResponse	PauseActivityExecutionResponse

Returns

void

---

PauseWorkflowExecution

Ƭ PauseWorkflowExecution: Object

Note: This is an experimental API and the behavior may change in a future release. PauseWorkflowExecution pauses the workflow execution specified in the request. Pausing a workflow execution results in

• The workflow execution status changes to PAUSED and a new WORKFLOW_EXECUTION_PAUSED event is added to the history
• No new workflow tasks or activity tasks are dispatched.
• Any workflow task currently executing on the worker will be allowed to complete.
• Any activity task currently executing will be paused.
• All server-side events will continue to be processed by the server.
• Queries & Updates on a paused workflow will be rejected.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPauseWorkflowExecutionRequest
callback	PauseWorkflowExecutionCallback

Returns

void

▸ (request): Promise<PauseWorkflowExecutionResponse>

Parameters

Name	Type
request	IPauseWorkflowExecutionRequest

Returns

Promise<PauseWorkflowExecutionResponse>

Type declaration

Name	Type
name	"PauseWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/PauseWorkflowExecution"
requestStream	undefined
requestType	"PauseWorkflowExecutionRequest"
responseStream	undefined
responseType	"PauseWorkflowExecutionResponse"

---

PauseWorkflowExecutionCallback

Ƭ PauseWorkflowExecutionCallback: (error: Error | null, response?: PauseWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pauseWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PauseWorkflowExecutionResponse	PauseWorkflowExecutionResponse

Returns

void

---

PollActivityExecution

Ƭ PollActivityExecution: Object

PollActivityExecution long-polls for an activity execution to complete and returns the outcome (result or failure).

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollActivityExecutionRequest
callback	PollActivityExecutionCallback

Returns

void

▸ (request): Promise<PollActivityExecutionResponse>

Parameters

Name	Type
request	IPollActivityExecutionRequest

Returns

Promise<PollActivityExecutionResponse>

Type declaration

Name	Type
name	"PollActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollActivityExecution"
requestStream	undefined
requestType	"PollActivityExecutionRequest"
responseStream	undefined
responseType	"PollActivityExecutionResponse"

---

PollActivityExecutionCallback

Ƭ PollActivityExecutionCallback: (error: Error | null, response?: PollActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollActivityExecutionResponse	PollActivityExecutionResponse

Returns

void

---

PollActivityTaskQueue

Ƭ PollActivityTaskQueue: Object

PollActivityTaskQueue is called by workers to process activity tasks from a specific task queue.

The worker is expected to call one of the RespondActivityTaskXXX methods when it is done processing the task.

An activity task is dispatched whenever a SCHEDULE_ACTIVITY_TASK command is produced during workflow execution. An in memory ACTIVITY_TASK_STARTED event is written to mutable state before the task is dispatched to the worker. The started event, and the final event (ACTIVITY_TASK_COMPLETED / ACTIVITY_TASK_FAILED / ACTIVITY_TASK_TIMED_OUT) will both be written permanently to Workflow execution history when Activity is finished. This is done to avoid writing many events in the case of a failure/retry loop.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollActivityTaskQueueRequest
callback	PollActivityTaskQueueCallback

Returns

void

▸ (request): Promise<PollActivityTaskQueueResponse>

Parameters

Name	Type
request	IPollActivityTaskQueueRequest

Returns

Promise<PollActivityTaskQueueResponse>

Type declaration

Name	Type
name	"PollActivityTaskQueue"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollActivityTaskQueue"
requestStream	undefined
requestType	"PollActivityTaskQueueRequest"
responseStream	undefined
responseType	"PollActivityTaskQueueResponse"

---

PollActivityTaskQueueCallback

Ƭ PollActivityTaskQueueCallback: (error: Error | null, response?: PollActivityTaskQueueResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollActivityTaskQueue.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollActivityTaskQueueResponse	PollActivityTaskQueueResponse

Returns

void

---

PollNexusOperationExecution

Ƭ PollNexusOperationExecution: Object

PollNexusOperationExecution long-polls for a Nexus operation for a given wait stage to complete and returns the outcome (result or failure).

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollNexusOperationExecutionRequest
callback	PollNexusOperationExecutionCallback

Returns

void

▸ (request): Promise<PollNexusOperationExecutionResponse>

Parameters

Name	Type
request	IPollNexusOperationExecutionRequest

Returns

Promise<PollNexusOperationExecutionResponse>

Type declaration

Name	Type
name	"PollNexusOperationExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollNexusOperationExecution"
requestStream	undefined
requestType	"PollNexusOperationExecutionRequest"
responseStream	undefined
responseType	"PollNexusOperationExecutionResponse"

---

PollNexusOperationExecutionCallback

Ƭ PollNexusOperationExecutionCallback: (error: Error | null, response?: PollNexusOperationExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollNexusOperationExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollNexusOperationExecutionResponse	PollNexusOperationExecutionResponse

Returns

void

---

PollNexusTaskQueue

Ƭ PollNexusTaskQueue: Object

PollNexusTaskQueue is a long poll call used by workers to receive Nexus tasks. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollNexusTaskQueueRequest
callback	PollNexusTaskQueueCallback

Returns

void

▸ (request): Promise<PollNexusTaskQueueResponse>

Parameters

Name	Type
request	IPollNexusTaskQueueRequest

Returns

Promise<PollNexusTaskQueueResponse>

Type declaration

Name	Type
name	"PollNexusTaskQueue"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollNexusTaskQueue"
requestStream	undefined
requestType	"PollNexusTaskQueueRequest"
responseStream	undefined
responseType	"PollNexusTaskQueueResponse"

---

PollNexusTaskQueueCallback

Ƭ PollNexusTaskQueueCallback: (error: Error | null, response?: PollNexusTaskQueueResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollNexusTaskQueue.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollNexusTaskQueueResponse	PollNexusTaskQueueResponse

Returns

void

---

PollWorkflowExecutionTimeSkipping

Ƭ PollWorkflowExecutionTimeSkipping: Object

Calls PollWorkflowExecutionTimeSkipping.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollWorkflowExecutionTimeSkippingRequest
callback	PollWorkflowExecutionTimeSkippingCallback

Returns

void

▸ (request): Promise<PollWorkflowExecutionTimeSkippingResponse>

Parameters

Name	Type
request	IPollWorkflowExecutionTimeSkippingRequest

Returns

Promise<PollWorkflowExecutionTimeSkippingResponse>

Type declaration

Name	Type
name	"PollWorkflowExecutionTimeSkipping"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollWorkflowExecutionTimeSkipping"
requestStream	undefined
requestType	"PollWorkflowExecutionTimeSkippingRequest"
responseStream	undefined
responseType	"PollWorkflowExecutionTimeSkippingResponse"

---

PollWorkflowExecutionTimeSkippingCallback

Ƭ PollWorkflowExecutionTimeSkippingCallback: (error: Error | null, response?: PollWorkflowExecutionTimeSkippingResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollWorkflowExecutionTimeSkipping.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollWorkflowExecutionTimeSkippingResponse	PollWorkflowExecutionTimeSkippingResponse

Returns

void

---

PollWorkflowExecutionUpdate

Ƭ PollWorkflowExecutionUpdate: Object

Polls a Workflow Execution for the outcome of a Workflow Update previously issued through the UpdateWorkflowExecution RPC. The effective timeout on this call will be shorter of the the caller-supplied gRPC timeout and the server's configured long-poll timeout.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We don't expose update polling API to HTTP in favor of a potential future non-blocking form. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollWorkflowExecutionUpdateRequest
callback	PollWorkflowExecutionUpdateCallback

Returns

void

▸ (request): Promise<PollWorkflowExecutionUpdateResponse>

Parameters

Name	Type
request	IPollWorkflowExecutionUpdateRequest

Returns

Promise<PollWorkflowExecutionUpdateResponse>

Type declaration

Name	Type
name	"PollWorkflowExecutionUpdate"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollWorkflowExecutionUpdate"
requestStream	undefined
requestType	"PollWorkflowExecutionUpdateRequest"
responseStream	undefined
responseType	"PollWorkflowExecutionUpdateResponse"

---

PollWorkflowExecutionUpdateCallback

Ƭ PollWorkflowExecutionUpdateCallback: (error: Error | null, response?: PollWorkflowExecutionUpdateResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollWorkflowExecutionUpdate.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollWorkflowExecutionUpdateResponse	PollWorkflowExecutionUpdateResponse

Returns

void

---

PollWorkflowTaskQueue

Ƭ PollWorkflowTaskQueue: Object

PollWorkflowTaskQueue is called by workers to make progress on workflows.

A WorkflowTask is dispatched to callers for active workflow executions with pending workflow tasks. The worker is expected to call RespondWorkflowTaskCompleted when it is done processing the task. The service will create a WorkflowTaskStarted event in the history for this task before handing it to the worker.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IPollWorkflowTaskQueueRequest
callback	PollWorkflowTaskQueueCallback

Returns

void

▸ (request): Promise<PollWorkflowTaskQueueResponse>

Parameters

Name	Type
request	IPollWorkflowTaskQueueRequest

Returns

Promise<PollWorkflowTaskQueueResponse>

Type declaration

Name	Type
name	"PollWorkflowTaskQueue"
path	"/temporal.api.workflowservice.v1.WorkflowService/PollWorkflowTaskQueue"
requestStream	undefined
requestType	"PollWorkflowTaskQueueRequest"
responseStream	undefined
responseType	"PollWorkflowTaskQueueResponse"

---

PollWorkflowTaskQueueCallback

Ƭ PollWorkflowTaskQueueCallback: (error: Error | null, response?: PollWorkflowTaskQueueResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollWorkflowTaskQueue.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	PollWorkflowTaskQueueResponse	PollWorkflowTaskQueueResponse

Returns

void

---

QueryWorkflow

Ƭ QueryWorkflow: Object

QueryWorkflow requests a query be executed for a specified workflow execution.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IQueryWorkflowRequest
callback	QueryWorkflowCallback

Returns

void

▸ (request): Promise<QueryWorkflowResponse>

Parameters

Name	Type
request	IQueryWorkflowRequest

Returns

Promise<QueryWorkflowResponse>

Type declaration

Name	Type
name	"QueryWorkflow"
path	"/temporal.api.workflowservice.v1.WorkflowService/QueryWorkflow"
requestStream	undefined
requestType	"QueryWorkflowRequest"
responseStream	undefined
responseType	"QueryWorkflowResponse"

---

QueryWorkflowCallback

Ƭ QueryWorkflowCallback: (error: Error | null, response?: QueryWorkflowResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#queryWorkflow.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	QueryWorkflowResponse	QueryWorkflowResponse

Returns

void

---

RecordActivityTaskHeartbeat

Ƭ RecordActivityTaskHeartbeat: Object

RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.

If a worker fails to heartbeat within the heartbeat_timeout interval for the activity task, then the current attempt times out. Depending on RetryPolicy, this may trigger a retry or time out the activity.

For workflow activities, an ACTIVITY_TASK_TIMED_OUT event will be written to the workflow history. Calling RecordActivityTaskHeartbeat will fail with NotFound in such situations, in that event, the SDK should request cancellation of the activity.

The request may contain response details which will be persisted by the server and may be used by the activity to checkpoint progress. The cancel_requested field in the response indicates whether cancellation has been requested for the activity.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRecordActivityTaskHeartbeatRequest
callback	RecordActivityTaskHeartbeatCallback

Returns

void

▸ (request): Promise<RecordActivityTaskHeartbeatResponse>

Parameters

Name	Type
request	IRecordActivityTaskHeartbeatRequest

Returns

Promise<RecordActivityTaskHeartbeatResponse>

Type declaration

Name	Type
name	"RecordActivityTaskHeartbeat"
path	"/temporal.api.workflowservice.v1.WorkflowService/RecordActivityTaskHeartbeat"
requestStream	undefined
requestType	"RecordActivityTaskHeartbeatRequest"
responseStream	undefined
responseType	"RecordActivityTaskHeartbeatResponse"

---

RecordActivityTaskHeartbeatById

Ƭ RecordActivityTaskHeartbeatById: Object

See RecordActivityTaskHeartbeat. This version allows clients to record heartbeats by namespace/workflow id/activity id instead of task token.

(-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRecordActivityTaskHeartbeatByIdRequest
callback	RecordActivityTaskHeartbeatByIdCallback

Returns

void

▸ (request): Promise<RecordActivityTaskHeartbeatByIdResponse>

Parameters

Name	Type
request	IRecordActivityTaskHeartbeatByIdRequest

Returns

Promise<RecordActivityTaskHeartbeatByIdResponse>

Type declaration

Name	Type
name	"RecordActivityTaskHeartbeatById"
path	"/temporal.api.workflowservice.v1.WorkflowService/RecordActivityTaskHeartbeatById"
requestStream	undefined
requestType	"RecordActivityTaskHeartbeatByIdRequest"
responseStream	undefined
responseType	"RecordActivityTaskHeartbeatByIdResponse"

---

RecordActivityTaskHeartbeatByIdCallback

Ƭ RecordActivityTaskHeartbeatByIdCallback: (error: Error | null, response?: RecordActivityTaskHeartbeatByIdResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#recordActivityTaskHeartbeatById.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RecordActivityTaskHeartbeatByIdResponse	RecordActivityTaskHeartbeatByIdResponse

Returns

void

---

RecordActivityTaskHeartbeatCallback

Ƭ RecordActivityTaskHeartbeatCallback: (error: Error | null, response?: RecordActivityTaskHeartbeatResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#recordActivityTaskHeartbeat.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RecordActivityTaskHeartbeatResponse	RecordActivityTaskHeartbeatResponse

Returns

void

---

RecordWorkerHeartbeat

Ƭ RecordWorkerHeartbeat: Object

WorkerHeartbeat receive heartbeat request from the worker.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRecordWorkerHeartbeatRequest
callback	RecordWorkerHeartbeatCallback

Returns

void

▸ (request): Promise<RecordWorkerHeartbeatResponse>

Parameters

Name	Type
request	IRecordWorkerHeartbeatRequest

Returns

Promise<RecordWorkerHeartbeatResponse>

Type declaration

Name	Type
name	"RecordWorkerHeartbeat"
path	"/temporal.api.workflowservice.v1.WorkflowService/RecordWorkerHeartbeat"
requestStream	undefined
requestType	"RecordWorkerHeartbeatRequest"
responseStream	undefined
responseType	"RecordWorkerHeartbeatResponse"

---

RecordWorkerHeartbeatCallback

Ƭ RecordWorkerHeartbeatCallback: (error: Error | null, response?: RecordWorkerHeartbeatResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#recordWorkerHeartbeat.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RecordWorkerHeartbeatResponse	RecordWorkerHeartbeatResponse

Returns

void

---

RegisterNamespace

Ƭ RegisterNamespace: Object

RegisterNamespace creates a new namespace which can be used as a container for all resources.

A Namespace is a top level entity within Temporal, and is used as a container for resources like workflow executions, task queues, etc. A Namespace acts as a sandbox and provides isolation for all resources within the namespace. All resources belongs to exactly one namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRegisterNamespaceRequest
callback	RegisterNamespaceCallback

Returns

void

▸ (request): Promise<RegisterNamespaceResponse>

Parameters

Name	Type
request	IRegisterNamespaceRequest

Returns

Promise<RegisterNamespaceResponse>

Type declaration

Name	Type
name	"RegisterNamespace"
path	"/temporal.api.workflowservice.v1.WorkflowService/RegisterNamespace"
requestStream	undefined
requestType	"RegisterNamespaceRequest"
responseStream	undefined
responseType	"RegisterNamespaceResponse"

---

RegisterNamespaceCallback

Ƭ RegisterNamespaceCallback: (error: Error | null, response?: RegisterNamespaceResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#registerNamespace.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RegisterNamespaceResponse	RegisterNamespaceResponse

Returns

void

---

RequestCancelActivityExecution

Ƭ RequestCancelActivityExecution: Object

RequestCancelActivityExecution requests cancellation of an activity execution.

Cancellation is cooperative: this call records the request, but the activity must detect and acknowledge it for the activity to reach CANCELED status. The cancellation signal is delivered via cancel_requested in the heartbeat response; SDKs surface this via language-idiomatic mechanisms (context cancellation, exceptions, abort signals).

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRequestCancelActivityExecutionRequest
callback	RequestCancelActivityExecutionCallback

Returns

void

▸ (request): Promise<RequestCancelActivityExecutionResponse>

Parameters

Name	Type
request	IRequestCancelActivityExecutionRequest

Returns

Promise<RequestCancelActivityExecutionResponse>

Type declaration

Name	Type
name	"RequestCancelActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/RequestCancelActivityExecution"
requestStream	undefined
requestType	"RequestCancelActivityExecutionRequest"
responseStream	undefined
responseType	"RequestCancelActivityExecutionResponse"

---

RequestCancelActivityExecutionCallback

Ƭ RequestCancelActivityExecutionCallback: (error: Error | null, response?: RequestCancelActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#requestCancelActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RequestCancelActivityExecutionResponse	RequestCancelActivityExecutionResponse

Returns

void

---

RequestCancelNexusOperationExecution

Ƭ RequestCancelNexusOperationExecution: Object

RequestCancelNexusOperationExecution requests cancellation of a Nexus operation.

Requesting to cancel an operation does not automatically transition the operation to canceled status. The operation will only transition to canceled status if it supports cancellation and the handler processes the cancellation request.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRequestCancelNexusOperationExecutionRequest
callback	RequestCancelNexusOperationExecutionCallback

Returns

void

▸ (request): Promise<RequestCancelNexusOperationExecutionResponse>

Parameters

Name	Type
request	IRequestCancelNexusOperationExecutionRequest

Returns

Promise<RequestCancelNexusOperationExecutionResponse>

Type declaration

Name	Type
name	"RequestCancelNexusOperationExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/RequestCancelNexusOperationExecution"
requestStream	undefined
requestType	"RequestCancelNexusOperationExecutionRequest"
responseStream	undefined
responseType	"RequestCancelNexusOperationExecutionResponse"

---

RequestCancelNexusOperationExecutionCallback

Ƭ RequestCancelNexusOperationExecutionCallback: (error: Error | null, response?: RequestCancelNexusOperationExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#requestCancelNexusOperationExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RequestCancelNexusOperationExecutionResponse	RequestCancelNexusOperationExecutionResponse

Returns

void

---

RequestCancelWorkflowExecution

Ƭ RequestCancelWorkflowExecution: Object

RequestCancelWorkflowExecution is called by workers when they want to request cancellation of a workflow execution.

This results in a new WORKFLOW_EXECUTION_CANCEL_REQUESTED event being written to the workflow history and a new workflow task created for the workflow. It returns success if the requested workflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRequestCancelWorkflowExecutionRequest
callback	RequestCancelWorkflowExecutionCallback

Returns

void

▸ (request): Promise<RequestCancelWorkflowExecutionResponse>

Parameters

Name	Type
request	IRequestCancelWorkflowExecutionRequest

Returns

Promise<RequestCancelWorkflowExecutionResponse>

Type declaration

Name	Type
name	"RequestCancelWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/RequestCancelWorkflowExecution"
requestStream	undefined
requestType	"RequestCancelWorkflowExecutionRequest"
responseStream	undefined
responseType	"RequestCancelWorkflowExecutionResponse"

---

RequestCancelWorkflowExecutionCallback

Ƭ RequestCancelWorkflowExecutionCallback: (error: Error | null, response?: RequestCancelWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#requestCancelWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RequestCancelWorkflowExecutionResponse	RequestCancelWorkflowExecutionResponse

Returns

void

---

ResetActivity

Ƭ ResetActivity: Object

ResetActivity resets the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them will be reset.

Resetting an activity means:

• number of attempts will be reset to 0.
• activity timeouts will be reset.
• if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided: it will be scheduled immediately (* see 'jitter' flag),

Flags:

'jitter': the activity will be scheduled at a random time within the jitter duration. If the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided. 'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset. 'keep_paused': if the activity is paused, it will remain paused.

Returns a NotFound error if there is no pending activity with the provided ID or type. This API will be deprecated soon and replaced with a newer ResetActivityExecution that is better named and structured to work well for standalone activities.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IResetActivityRequest
callback	ResetActivityCallback

Returns

void

▸ (request): Promise<ResetActivityResponse>

Parameters

Name	Type
request	IResetActivityRequest

Returns

Promise<ResetActivityResponse>

Type declaration

Name	Type
name	"ResetActivity"
path	"/temporal.api.workflowservice.v1.WorkflowService/ResetActivity"
requestStream	undefined
requestType	"ResetActivityRequest"
responseStream	undefined
responseType	"ResetActivityResponse"

---

ResetActivityCallback

Ƭ ResetActivityCallback: (error: Error | null, response?: ResetActivityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetActivity.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ResetActivityResponse	ResetActivityResponse

Returns

void

---

ResetActivityExecution

Ƭ ResetActivityExecution: Object

ResetActivityExecution resets the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity.

Resetting an activity means:

• number of attempts will be reset to 0.
• activity timeouts will be reset.
• if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided: it will be scheduled immediately (* see 'jitter' flag)

Returns a NotFound error if there is no pending activity with the provided ID or type.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IResetActivityExecutionRequest
callback	ResetActivityExecutionCallback

Returns

void

▸ (request): Promise<ResetActivityExecutionResponse>

Parameters

Name	Type
request	IResetActivityExecutionRequest

Returns

Promise<ResetActivityExecutionResponse>

Type declaration

Name	Type
name	"ResetActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/ResetActivityExecution"
requestStream	undefined
requestType	"ResetActivityExecutionRequest"
responseStream	undefined
responseType	"ResetActivityExecutionResponse"

---

ResetActivityExecutionCallback

Ƭ ResetActivityExecutionCallback: (error: Error | null, response?: ResetActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ResetActivityExecutionResponse	ResetActivityExecutionResponse

Returns

void

---

ResetStickyTaskQueue

Ƭ ResetStickyTaskQueue: Object

ResetStickyTaskQueue resets the sticky task queue related information in the mutable state of a given workflow. This is prudent for workers to perform if a workflow has been paged out of their cache.

Things cleared are:

1. StickyTaskQueue
2. StickyScheduleToStartTimeout

When possible, ShutdownWorker should be preferred over ResetStickyTaskQueue (particularly when a worker is shutting down or cycling).

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IResetStickyTaskQueueRequest
callback	ResetStickyTaskQueueCallback

Returns

void

▸ (request): Promise<ResetStickyTaskQueueResponse>

Parameters

Name	Type
request	IResetStickyTaskQueueRequest

Returns

Promise<ResetStickyTaskQueueResponse>

Type declaration

Name	Type
name	"ResetStickyTaskQueue"
path	"/temporal.api.workflowservice.v1.WorkflowService/ResetStickyTaskQueue"
requestStream	undefined
requestType	"ResetStickyTaskQueueRequest"
responseStream	undefined
responseType	"ResetStickyTaskQueueResponse"

---

ResetStickyTaskQueueCallback

Ƭ ResetStickyTaskQueueCallback: (error: Error | null, response?: ResetStickyTaskQueueResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetStickyTaskQueue.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ResetStickyTaskQueueResponse	ResetStickyTaskQueueResponse

Returns

void

---

ResetWorkflowExecution

Ƭ ResetWorkflowExecution: Object

ResetWorkflowExecution will reset an existing workflow execution to a specified WORKFLOW_TASK_COMPLETED event (exclusive). It will immediately terminate the current execution instance. "Exclusive" means the identified completed event itself is not replayed in the reset history; the preceding WORKFLOW_TASK_STARTED event remains and will be marked as failed immediately, and a new workflow task will be scheduled to retry it.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IResetWorkflowExecutionRequest
callback	ResetWorkflowExecutionCallback

Returns

void

▸ (request): Promise<ResetWorkflowExecutionResponse>

Parameters

Name	Type
request	IResetWorkflowExecutionRequest

Returns

Promise<ResetWorkflowExecutionResponse>

Type declaration

Name	Type
name	"ResetWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/ResetWorkflowExecution"
requestStream	undefined
requestType	"ResetWorkflowExecutionRequest"
responseStream	undefined
responseType	"ResetWorkflowExecutionResponse"

---

ResetWorkflowExecutionCallback

Ƭ ResetWorkflowExecutionCallback: (error: Error | null, response?: ResetWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ResetWorkflowExecutionResponse	ResetWorkflowExecutionResponse

Returns

void

---

RespondActivityTaskCanceled

Ƭ RespondActivityTaskCanceled: Object

RespondActivityTaskFailed is called by workers when processing an activity task fails.

For workflow activities, this results in a new ACTIVITY_TASK_CANCELED event being written to the workflow history and a new workflow task created for the workflow. Fails with NotFound if the task token is no longer valid due to activity timeout, already being completed, or never having existed.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondActivityTaskCanceledRequest
callback	RespondActivityTaskCanceledCallback

Returns

void

▸ (request): Promise<RespondActivityTaskCanceledResponse>

Parameters

Name	Type
request	IRespondActivityTaskCanceledRequest

Returns

Promise<RespondActivityTaskCanceledResponse>

Type declaration

Name	Type
name	"RespondActivityTaskCanceled"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCanceled"
requestStream	undefined
requestType	"RespondActivityTaskCanceledRequest"
responseStream	undefined
responseType	"RespondActivityTaskCanceledResponse"

---

RespondActivityTaskCanceledById

Ƭ RespondActivityTaskCanceledById: Object

See RespondActivityTaskCanceled. This version allows clients to record failures by namespace/workflow id/activity id instead of task token.

(-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondActivityTaskCanceledByIdRequest
callback	RespondActivityTaskCanceledByIdCallback

Returns

void

▸ (request): Promise<RespondActivityTaskCanceledByIdResponse>

Parameters

Name	Type
request	IRespondActivityTaskCanceledByIdRequest

Returns

Promise<RespondActivityTaskCanceledByIdResponse>

Type declaration

Name	Type
name	"RespondActivityTaskCanceledById"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCanceledById"
requestStream	undefined
requestType	"RespondActivityTaskCanceledByIdRequest"
responseStream	undefined
responseType	"RespondActivityTaskCanceledByIdResponse"

---

RespondActivityTaskCanceledByIdCallback

Ƭ RespondActivityTaskCanceledByIdCallback: (error: Error | null, response?: RespondActivityTaskCanceledByIdResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCanceledById.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondActivityTaskCanceledByIdResponse	RespondActivityTaskCanceledByIdResponse

Returns

void

---

RespondActivityTaskCanceledCallback

Ƭ RespondActivityTaskCanceledCallback: (error: Error | null, response?: RespondActivityTaskCanceledResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCanceled.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondActivityTaskCanceledResponse	RespondActivityTaskCanceledResponse

Returns

void

---

RespondActivityTaskCompleted

Ƭ RespondActivityTaskCompleted: Object

RespondActivityTaskCompleted is called by workers when they successfully complete an activity task.

For workflow activities, this results in a new ACTIVITY_TASK_COMPLETED event being written to the workflow history and a new workflow task created for the workflow. Fails with NotFound if the task token is no longer valid due to activity timeout, already being completed, or never having existed.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondActivityTaskCompletedRequest
callback	RespondActivityTaskCompletedCallback

Returns

void

▸ (request): Promise<RespondActivityTaskCompletedResponse>

Parameters

Name	Type
request	IRespondActivityTaskCompletedRequest

Returns

Promise<RespondActivityTaskCompletedResponse>

Type declaration

Name	Type
name	"RespondActivityTaskCompleted"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCompleted"
requestStream	undefined
requestType	"RespondActivityTaskCompletedRequest"
responseStream	undefined
responseType	"RespondActivityTaskCompletedResponse"

---

RespondActivityTaskCompletedById

Ƭ RespondActivityTaskCompletedById: Object

See RespondActivityTaskCompleted. This version allows clients to record completions by namespace/workflow id/activity id instead of task token.

(-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondActivityTaskCompletedByIdRequest
callback	RespondActivityTaskCompletedByIdCallback

Returns

void

▸ (request): Promise<RespondActivityTaskCompletedByIdResponse>

Parameters

Name	Type
request	IRespondActivityTaskCompletedByIdRequest

Returns

Promise<RespondActivityTaskCompletedByIdResponse>

Type declaration

Name	Type
name	"RespondActivityTaskCompletedById"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCompletedById"
requestStream	undefined
requestType	"RespondActivityTaskCompletedByIdRequest"
responseStream	undefined
responseType	"RespondActivityTaskCompletedByIdResponse"

---

RespondActivityTaskCompletedByIdCallback

Ƭ RespondActivityTaskCompletedByIdCallback: (error: Error | null, response?: RespondActivityTaskCompletedByIdResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCompletedById.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondActivityTaskCompletedByIdResponse	RespondActivityTaskCompletedByIdResponse

Returns

void

---

RespondActivityTaskCompletedCallback

Ƭ RespondActivityTaskCompletedCallback: (error: Error | null, response?: RespondActivityTaskCompletedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCompleted.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondActivityTaskCompletedResponse	RespondActivityTaskCompletedResponse

Returns

void

---

RespondActivityTaskFailed

Ƭ RespondActivityTaskFailed: Object

RespondActivityTaskFailed is called by workers when processing an activity task fails.

This results in a new ACTIVITY_TASK_FAILED event being written to the workflow history and a new workflow task created for the workflow. Fails with NotFound if the task token is no longer valid due to activity timeout, already being completed, or never having existed.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondActivityTaskFailedRequest
callback	RespondActivityTaskFailedCallback

Returns

void

▸ (request): Promise<RespondActivityTaskFailedResponse>

Parameters

Name	Type
request	IRespondActivityTaskFailedRequest

Returns

Promise<RespondActivityTaskFailedResponse>

Type declaration

Name	Type
name	"RespondActivityTaskFailed"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskFailed"
requestStream	undefined
requestType	"RespondActivityTaskFailedRequest"
responseStream	undefined
responseType	"RespondActivityTaskFailedResponse"

---

RespondActivityTaskFailedById

Ƭ RespondActivityTaskFailedById: Object

See RecordActivityTaskFailed. This version allows clients to record failures by namespace/workflow id/activity id instead of task token.

(-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondActivityTaskFailedByIdRequest
callback	RespondActivityTaskFailedByIdCallback

Returns

void

▸ (request): Promise<RespondActivityTaskFailedByIdResponse>

Parameters

Name	Type
request	IRespondActivityTaskFailedByIdRequest

Returns

Promise<RespondActivityTaskFailedByIdResponse>

Type declaration

Name	Type
name	"RespondActivityTaskFailedById"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskFailedById"
requestStream	undefined
requestType	"RespondActivityTaskFailedByIdRequest"
responseStream	undefined
responseType	"RespondActivityTaskFailedByIdResponse"

---

RespondActivityTaskFailedByIdCallback

Ƭ RespondActivityTaskFailedByIdCallback: (error: Error | null, response?: RespondActivityTaskFailedByIdResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskFailedById.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondActivityTaskFailedByIdResponse	RespondActivityTaskFailedByIdResponse

Returns

void

---

RespondActivityTaskFailedCallback

Ƭ RespondActivityTaskFailedCallback: (error: Error | null, response?: RespondActivityTaskFailedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskFailed.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondActivityTaskFailedResponse	RespondActivityTaskFailedResponse

Returns

void

---

RespondNexusTaskCompleted

Ƭ RespondNexusTaskCompleted: Object

RespondNexusTaskCompleted is called by workers to respond to Nexus tasks received via PollNexusTaskQueue. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondNexusTaskCompletedRequest
callback	RespondNexusTaskCompletedCallback

Returns

void

▸ (request): Promise<RespondNexusTaskCompletedResponse>

Parameters

Name	Type
request	IRespondNexusTaskCompletedRequest

Returns

Promise<RespondNexusTaskCompletedResponse>

Type declaration

Name	Type
name	"RespondNexusTaskCompleted"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondNexusTaskCompleted"
requestStream	undefined
requestType	"RespondNexusTaskCompletedRequest"
responseStream	undefined
responseType	"RespondNexusTaskCompletedResponse"

---

RespondNexusTaskCompletedCallback

Ƭ RespondNexusTaskCompletedCallback: (error: Error | null, response?: RespondNexusTaskCompletedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondNexusTaskCompleted.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondNexusTaskCompletedResponse	RespondNexusTaskCompletedResponse

Returns

void

---

RespondNexusTaskFailed

Ƭ RespondNexusTaskFailed: Object

RespondNexusTaskFailed is called by workers to fail Nexus tasks received via PollNexusTaskQueue. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondNexusTaskFailedRequest
callback	RespondNexusTaskFailedCallback

Returns

void

▸ (request): Promise<RespondNexusTaskFailedResponse>

Parameters

Name	Type
request	IRespondNexusTaskFailedRequest

Returns

Promise<RespondNexusTaskFailedResponse>

Type declaration

Name	Type
name	"RespondNexusTaskFailed"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondNexusTaskFailed"
requestStream	undefined
requestType	"RespondNexusTaskFailedRequest"
responseStream	undefined
responseType	"RespondNexusTaskFailedResponse"

---

RespondNexusTaskFailedCallback

Ƭ RespondNexusTaskFailedCallback: (error: Error | null, response?: RespondNexusTaskFailedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondNexusTaskFailed.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondNexusTaskFailedResponse	RespondNexusTaskFailedResponse

Returns

void

---

RespondQueryTaskCompleted

Ƭ RespondQueryTaskCompleted: Object

RespondQueryTaskCompleted is called by workers to complete queries which were delivered on the query (not queries) field of a PollWorkflowTaskQueueResponse.

Completing the query will unblock the corresponding client call to QueryWorkflow and return the query result a response.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondQueryTaskCompletedRequest
callback	RespondQueryTaskCompletedCallback

Returns

void

▸ (request): Promise<RespondQueryTaskCompletedResponse>

Parameters

Name	Type
request	IRespondQueryTaskCompletedRequest

Returns

Promise<RespondQueryTaskCompletedResponse>

Type declaration

Name	Type
name	"RespondQueryTaskCompleted"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondQueryTaskCompleted"
requestStream	undefined
requestType	"RespondQueryTaskCompletedRequest"
responseStream	undefined
responseType	"RespondQueryTaskCompletedResponse"

---

RespondQueryTaskCompletedCallback

Ƭ RespondQueryTaskCompletedCallback: (error: Error | null, response?: RespondQueryTaskCompletedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondQueryTaskCompleted.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondQueryTaskCompletedResponse	RespondQueryTaskCompletedResponse

Returns

void

---

RespondWorkflowTaskCompleted

Ƭ RespondWorkflowTaskCompleted: Object

RespondWorkflowTaskCompleted is called by workers to successfully complete workflow tasks they received from PollWorkflowTaskQueue.

Completing a WorkflowTask will write a WORKFLOW_TASK_COMPLETED event to the workflow's history, along with events corresponding to whatever commands the SDK generated while executing the task (ex timer started, activity task scheduled, etc).

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondWorkflowTaskCompletedRequest
callback	RespondWorkflowTaskCompletedCallback

Returns

void

▸ (request): Promise<RespondWorkflowTaskCompletedResponse>

Parameters

Name	Type
request	IRespondWorkflowTaskCompletedRequest

Returns

Promise<RespondWorkflowTaskCompletedResponse>

Type declaration

Name	Type
name	"RespondWorkflowTaskCompleted"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondWorkflowTaskCompleted"
requestStream	undefined
requestType	"RespondWorkflowTaskCompletedRequest"
responseStream	undefined
responseType	"RespondWorkflowTaskCompletedResponse"

---

RespondWorkflowTaskCompletedCallback

Ƭ RespondWorkflowTaskCompletedCallback: (error: Error | null, response?: RespondWorkflowTaskCompletedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondWorkflowTaskCompleted.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondWorkflowTaskCompletedResponse	RespondWorkflowTaskCompletedResponse

Returns

void

---

RespondWorkflowTaskFailed

Ƭ RespondWorkflowTaskFailed: Object

RespondWorkflowTaskFailed is called by workers to indicate the processing of a workflow task failed.

This results in a WORKFLOW_TASK_FAILED event written to the history, and a new workflow task will be scheduled. This API can be used to report unhandled failures resulting from applying the workflow task.

Temporal will only append first WorkflowTaskFailed event to the history of workflow execution for consecutive failures.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRespondWorkflowTaskFailedRequest
callback	RespondWorkflowTaskFailedCallback

Returns

void

▸ (request): Promise<RespondWorkflowTaskFailedResponse>

Parameters

Name	Type
request	IRespondWorkflowTaskFailedRequest

Returns

Promise<RespondWorkflowTaskFailedResponse>

Type declaration

Name	Type
name	"RespondWorkflowTaskFailed"
path	"/temporal.api.workflowservice.v1.WorkflowService/RespondWorkflowTaskFailed"
requestStream	undefined
requestType	"RespondWorkflowTaskFailedRequest"
responseStream	undefined
responseType	"RespondWorkflowTaskFailedResponse"

---

RespondWorkflowTaskFailedCallback

Ƭ RespondWorkflowTaskFailedCallback: (error: Error | null, response?: RespondWorkflowTaskFailedResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondWorkflowTaskFailed.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RespondWorkflowTaskFailedResponse	RespondWorkflowTaskFailedResponse

Returns

void

---

ScanWorkflowExecutions

Ƭ ScanWorkflowExecutions: Object

ScanWorkflowExecutions was a visibility API to list large amount of workflow executions in a specific namespace without order. It has since been deprecated in favor of ListWorkflowExecutions and rewritten to use ListWorkflowExecutions internally.

Deprecated: Replaced with ListWorkflowExecutions. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IScanWorkflowExecutionsRequest
callback	ScanWorkflowExecutionsCallback

Returns

void

▸ (request): Promise<ScanWorkflowExecutionsResponse>

Parameters

Name	Type
request	IScanWorkflowExecutionsRequest

Returns

Promise<ScanWorkflowExecutionsResponse>

Type declaration

Name	Type
name	"ScanWorkflowExecutions"
path	"/temporal.api.workflowservice.v1.WorkflowService/ScanWorkflowExecutions"
requestStream	undefined
requestType	"ScanWorkflowExecutionsRequest"
responseStream	undefined
responseType	"ScanWorkflowExecutionsResponse"

---

ScanWorkflowExecutionsCallback

Ƭ ScanWorkflowExecutionsCallback: (error: Error | null, response?: ScanWorkflowExecutionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#scanWorkflowExecutions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ScanWorkflowExecutionsResponse	ScanWorkflowExecutionsResponse

Returns

void

---

SetCurrentDeployment

Ƭ SetCurrentDeployment: Object

Sets a deployment as the current deployment for its deployment series. Can optionally update the metadata of the deployment as well. Deprecated. Replaced by SetWorkerDeploymentCurrentVersion.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ISetCurrentDeploymentRequest
callback	SetCurrentDeploymentCallback

Returns

void

▸ (request): Promise<SetCurrentDeploymentResponse>

Parameters

Name	Type
request	ISetCurrentDeploymentRequest

Returns

Promise<SetCurrentDeploymentResponse>

Type declaration

Name	Type
name	"SetCurrentDeployment"
path	"/temporal.api.workflowservice.v1.WorkflowService/SetCurrentDeployment"
requestStream	undefined
requestType	"SetCurrentDeploymentRequest"
responseStream	undefined
responseType	"SetCurrentDeploymentResponse"

---

SetCurrentDeploymentCallback

Ƭ SetCurrentDeploymentCallback: (error: Error | null, response?: SetCurrentDeploymentResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#setCurrentDeployment.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	SetCurrentDeploymentResponse	SetCurrentDeploymentResponse

Returns

void

---

SetWorkerDeploymentCurrentVersion

Ƭ SetWorkerDeploymentCurrentVersion: Object

Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping Version if it is the Version being set as Current.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ISetWorkerDeploymentCurrentVersionRequest
callback	SetWorkerDeploymentCurrentVersionCallback

Returns

void

▸ (request): Promise<SetWorkerDeploymentCurrentVersionResponse>

Parameters

Name	Type
request	ISetWorkerDeploymentCurrentVersionRequest

Returns

Promise<SetWorkerDeploymentCurrentVersionResponse>

Type declaration

Name	Type
name	"SetWorkerDeploymentCurrentVersion"
path	"/temporal.api.workflowservice.v1.WorkflowService/SetWorkerDeploymentCurrentVersion"
requestStream	undefined
requestType	"SetWorkerDeploymentCurrentVersionRequest"
responseStream	undefined
responseType	"SetWorkerDeploymentCurrentVersionResponse"

---

SetWorkerDeploymentCurrentVersionCallback

Ƭ SetWorkerDeploymentCurrentVersionCallback: (error: Error | null, response?: SetWorkerDeploymentCurrentVersionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#setWorkerDeploymentCurrentVersion.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	SetWorkerDeploymentCurrentVersionResponse	SetWorkerDeploymentCurrentVersionResponse

Returns

void

---

SetWorkerDeploymentManager

Ƭ SetWorkerDeploymentManager: Object

Set/unset the ManagerIdentity of a Worker Deployment. Experimental. This API might significantly change or be removed in a future release.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ISetWorkerDeploymentManagerRequest
callback	SetWorkerDeploymentManagerCallback

Returns

void

▸ (request): Promise<SetWorkerDeploymentManagerResponse>

Parameters

Name	Type
request	ISetWorkerDeploymentManagerRequest

Returns

Promise<SetWorkerDeploymentManagerResponse>

Type declaration

Name	Type
name	"SetWorkerDeploymentManager"
path	"/temporal.api.workflowservice.v1.WorkflowService/SetWorkerDeploymentManager"
requestStream	undefined
requestType	"SetWorkerDeploymentManagerRequest"
responseStream	undefined
responseType	"SetWorkerDeploymentManagerResponse"

---

SetWorkerDeploymentManagerCallback

Ƭ SetWorkerDeploymentManagerCallback: (error: Error | null, response?: SetWorkerDeploymentManagerResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#setWorkerDeploymentManager.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	SetWorkerDeploymentManagerResponse	SetWorkerDeploymentManagerResponse

Returns

void

---

SetWorkerDeploymentRampingVersion

Ƭ SetWorkerDeploymentRampingVersion: Object

Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for gradual ramp to unversioned workers too.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ISetWorkerDeploymentRampingVersionRequest
callback	SetWorkerDeploymentRampingVersionCallback

Returns

void

▸ (request): Promise<SetWorkerDeploymentRampingVersionResponse>

Parameters

Name	Type
request	ISetWorkerDeploymentRampingVersionRequest

Returns

Promise<SetWorkerDeploymentRampingVersionResponse>

Type declaration

Name	Type
name	"SetWorkerDeploymentRampingVersion"
path	"/temporal.api.workflowservice.v1.WorkflowService/SetWorkerDeploymentRampingVersion"
requestStream	undefined
requestType	"SetWorkerDeploymentRampingVersionRequest"
responseStream	undefined
responseType	"SetWorkerDeploymentRampingVersionResponse"

---

SetWorkerDeploymentRampingVersionCallback

Ƭ SetWorkerDeploymentRampingVersionCallback: (error: Error | null, response?: SetWorkerDeploymentRampingVersionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#setWorkerDeploymentRampingVersion.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	SetWorkerDeploymentRampingVersionResponse	SetWorkerDeploymentRampingVersionResponse

Returns

void

---

ShutdownWorker

Ƭ ShutdownWorker: Object

ShutdownWorker is used to indicate that the given sticky task queue is no longer being polled by its worker. Following the completion of ShutdownWorker, newly-added workflow tasks will instead be placed in the normal task queue, eligible for any worker to pick up.

ShutdownWorker should be called by workers while shutting down, after they've shut down their pollers. If another sticky poll request is issued, the sticky task queue will be revived.

As of Temporal Server v1.25.0, ShutdownWorker hasn't yet been implemented.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IShutdownWorkerRequest
callback	ShutdownWorkerCallback

Returns

void

▸ (request): Promise<ShutdownWorkerResponse>

Parameters

Name	Type
request	IShutdownWorkerRequest

Returns

Promise<ShutdownWorkerResponse>

Type declaration

Name	Type
name	"ShutdownWorker"
path	"/temporal.api.workflowservice.v1.WorkflowService/ShutdownWorker"
requestStream	undefined
requestType	"ShutdownWorkerRequest"
responseStream	undefined
responseType	"ShutdownWorkerResponse"

---

ShutdownWorkerCallback

Ƭ ShutdownWorkerCallback: (error: Error | null, response?: ShutdownWorkerResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#shutdownWorker.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ShutdownWorkerResponse	ShutdownWorkerResponse

Returns

void

---

SignalWithStartWorkflowExecution

Ƭ SignalWithStartWorkflowExecution: Object

SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if it isn't yet started.

If the workflow is running, a WORKFLOW_EXECUTION_SIGNALED event is recorded in the history and a workflow task is generated.

If the workflow is not running or not found, then the workflow is created with WORKFLOW_EXECUTION_STARTED and WORKFLOW_EXECUTION_SIGNALED events in its history, and a workflow task is generated.

(-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "With" is used to indicate combined operation. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ISignalWithStartWorkflowExecutionRequest
callback	SignalWithStartWorkflowExecutionCallback

Returns

void

▸ (request): Promise<SignalWithStartWorkflowExecutionResponse>

Parameters

Name	Type
request	ISignalWithStartWorkflowExecutionRequest

Returns

Promise<SignalWithStartWorkflowExecutionResponse>

Type declaration

Name	Type
name	"SignalWithStartWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/SignalWithStartWorkflowExecution"
requestStream	undefined
requestType	"SignalWithStartWorkflowExecutionRequest"
responseStream	undefined
responseType	"SignalWithStartWorkflowExecutionResponse"

---

SignalWithStartWorkflowExecutionCallback

Ƭ SignalWithStartWorkflowExecutionCallback: (error: Error | null, response?: SignalWithStartWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#signalWithStartWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	SignalWithStartWorkflowExecutionResponse	SignalWithStartWorkflowExecutionResponse

Returns

void

---

SignalWorkflowExecution

Ƭ SignalWorkflowExecution: Object

SignalWorkflowExecution is used to send a signal to a running workflow execution.

This results in a WORKFLOW_EXECUTION_SIGNALED event recorded in the history and a workflow task being created for the execution.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ISignalWorkflowExecutionRequest
callback	SignalWorkflowExecutionCallback

Returns

void

▸ (request): Promise<SignalWorkflowExecutionResponse>

Parameters

Name	Type
request	ISignalWorkflowExecutionRequest

Returns

Promise<SignalWorkflowExecutionResponse>

Type declaration

Name	Type
name	"SignalWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/SignalWorkflowExecution"
requestStream	undefined
requestType	"SignalWorkflowExecutionRequest"
responseStream	undefined
responseType	"SignalWorkflowExecutionResponse"

---

SignalWorkflowExecutionCallback

Ƭ SignalWorkflowExecutionCallback: (error: Error | null, response?: SignalWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#signalWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	SignalWorkflowExecutionResponse	SignalWorkflowExecutionResponse

Returns

void

---

StartActivityExecution

Ƭ StartActivityExecution: Object

StartActivityExecution starts a new activity execution.

Returns an ActivityExecutionAlreadyStarted error if an instance already exists with same activity ID in this namespace unless permitted by the specified ID conflict policy.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IStartActivityExecutionRequest
callback	StartActivityExecutionCallback

Returns

void

▸ (request): Promise<StartActivityExecutionResponse>

Parameters

Name	Type
request	IStartActivityExecutionRequest

Returns

Promise<StartActivityExecutionResponse>

Type declaration

Name	Type
name	"StartActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/StartActivityExecution"
requestStream	undefined
requestType	"StartActivityExecutionRequest"
responseStream	undefined
responseType	"StartActivityExecutionResponse"

---

StartActivityExecutionCallback

Ƭ StartActivityExecutionCallback: (error: Error | null, response?: StartActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#startActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	StartActivityExecutionResponse	StartActivityExecutionResponse

Returns

void

---

StartBatchOperation

Ƭ StartBatchOperation: Object

StartBatchOperation starts a new batch operation

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IStartBatchOperationRequest
callback	StartBatchOperationCallback

Returns

void

▸ (request): Promise<StartBatchOperationResponse>

Parameters

Name	Type
request	IStartBatchOperationRequest

Returns

Promise<StartBatchOperationResponse>

Type declaration

Name	Type
name	"StartBatchOperation"
path	"/temporal.api.workflowservice.v1.WorkflowService/StartBatchOperation"
requestStream	undefined
requestType	"StartBatchOperationRequest"
responseStream	undefined
responseType	"StartBatchOperationResponse"

---

StartBatchOperationCallback

Ƭ StartBatchOperationCallback: (error: Error | null, response?: StartBatchOperationResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#startBatchOperation.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	StartBatchOperationResponse	StartBatchOperationResponse

Returns

void

---

StartNexusOperationExecution

Ƭ StartNexusOperationExecution: Object

StartNexusOperationExecution starts a new Nexus operation.

Returns a NexusOperationExecutionAlreadyStarted error if an instance already exists with same operation ID in this namespace unless permitted by the specified ID conflict policy.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IStartNexusOperationExecutionRequest
callback	StartNexusOperationExecutionCallback

Returns

void

▸ (request): Promise<StartNexusOperationExecutionResponse>

Parameters

Name	Type
request	IStartNexusOperationExecutionRequest

Returns

Promise<StartNexusOperationExecutionResponse>

Type declaration

Name	Type
name	"StartNexusOperationExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/StartNexusOperationExecution"
requestStream	undefined
requestType	"StartNexusOperationExecutionRequest"
responseStream	undefined
responseType	"StartNexusOperationExecutionResponse"

---

StartNexusOperationExecutionCallback

Ƭ StartNexusOperationExecutionCallback: (error: Error | null, response?: StartNexusOperationExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#startNexusOperationExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	StartNexusOperationExecutionResponse	StartNexusOperationExecutionResponse

Returns

void

---

StartWorkflowExecution

Ƭ StartWorkflowExecution: Object

StartWorkflowExecution starts a new workflow execution.

It will create the execution with a WORKFLOW_EXECUTION_STARTED event in its history and also schedule the first workflow task. Returns WorkflowExecutionAlreadyStarted, if an instance already exists with same workflow id.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IStartWorkflowExecutionRequest
callback	StartWorkflowExecutionCallback

Returns

void

▸ (request): Promise<StartWorkflowExecutionResponse>

Parameters

Name	Type
request	IStartWorkflowExecutionRequest

Returns

Promise<StartWorkflowExecutionResponse>

Type declaration

Name	Type
name	"StartWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/StartWorkflowExecution"
requestStream	undefined
requestType	"StartWorkflowExecutionRequest"
responseStream	undefined
responseType	"StartWorkflowExecutionResponse"

---

StartWorkflowExecutionCallback

Ƭ StartWorkflowExecutionCallback: (error: Error | null, response?: StartWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#startWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	StartWorkflowExecutionResponse	StartWorkflowExecutionResponse

Returns

void

---

StopBatchOperation

Ƭ StopBatchOperation: Object

StopBatchOperation stops a batch operation

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IStopBatchOperationRequest
callback	StopBatchOperationCallback

Returns

void

▸ (request): Promise<StopBatchOperationResponse>

Parameters

Name	Type
request	IStopBatchOperationRequest

Returns

Promise<StopBatchOperationResponse>

Type declaration

Name	Type
name	"StopBatchOperation"
path	"/temporal.api.workflowservice.v1.WorkflowService/StopBatchOperation"
requestStream	undefined
requestType	"StopBatchOperationRequest"
responseStream	undefined
responseType	"StopBatchOperationResponse"

---

StopBatchOperationCallback

Ƭ StopBatchOperationCallback: (error: Error | null, response?: StopBatchOperationResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#stopBatchOperation.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	StopBatchOperationResponse	StopBatchOperationResponse

Returns

void

---

TerminateActivityExecution

Ƭ TerminateActivityExecution: Object

TerminateActivityExecution terminates an existing activity execution immediately.

Termination does not reach the worker and the activity code cannot react to it. A terminated activity may have a running attempt.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ITerminateActivityExecutionRequest
callback	TerminateActivityExecutionCallback

Returns

void

▸ (request): Promise<TerminateActivityExecutionResponse>

Parameters

Name	Type
request	ITerminateActivityExecutionRequest

Returns

Promise<TerminateActivityExecutionResponse>

Type declaration

Name	Type
name	"TerminateActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/TerminateActivityExecution"
requestStream	undefined
requestType	"TerminateActivityExecutionRequest"
responseStream	undefined
responseType	"TerminateActivityExecutionResponse"

---

TerminateActivityExecutionCallback

Ƭ TerminateActivityExecutionCallback: (error: Error | null, response?: TerminateActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#terminateActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	TerminateActivityExecutionResponse	TerminateActivityExecutionResponse

Returns

void

---

TerminateNexusOperationExecution

Ƭ TerminateNexusOperationExecution: Object

TerminateNexusOperationExecution terminates an existing Nexus operation immediately.

Termination happens immediately and the operation handler cannot react to it. A terminated operation will have its outcome set to a failure with a termination reason.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ITerminateNexusOperationExecutionRequest
callback	TerminateNexusOperationExecutionCallback

Returns

void

▸ (request): Promise<TerminateNexusOperationExecutionResponse>

Parameters

Name	Type
request	ITerminateNexusOperationExecutionRequest

Returns

Promise<TerminateNexusOperationExecutionResponse>

Type declaration

Name	Type
name	"TerminateNexusOperationExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/TerminateNexusOperationExecution"
requestStream	undefined
requestType	"TerminateNexusOperationExecutionRequest"
responseStream	undefined
responseType	"TerminateNexusOperationExecutionResponse"

---

TerminateNexusOperationExecutionCallback

Ƭ TerminateNexusOperationExecutionCallback: (error: Error | null, response?: TerminateNexusOperationExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#terminateNexusOperationExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	TerminateNexusOperationExecutionResponse	TerminateNexusOperationExecutionResponse

Returns

void

---

TerminateWorkflowExecution

Ƭ TerminateWorkflowExecution: Object

TerminateWorkflowExecution terminates an existing workflow execution by recording a WORKFLOW_EXECUTION_TERMINATED event in the history and immediately terminating the execution instance.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ITerminateWorkflowExecutionRequest
callback	TerminateWorkflowExecutionCallback

Returns

void

▸ (request): Promise<TerminateWorkflowExecutionResponse>

Parameters

Name	Type
request	ITerminateWorkflowExecutionRequest

Returns

Promise<TerminateWorkflowExecutionResponse>

Type declaration

Name	Type
name	"TerminateWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/TerminateWorkflowExecution"
requestStream	undefined
requestType	"TerminateWorkflowExecutionRequest"
responseStream	undefined
responseType	"TerminateWorkflowExecutionResponse"

---

TerminateWorkflowExecutionCallback

Ƭ TerminateWorkflowExecutionCallback: (error: Error | null, response?: TerminateWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#terminateWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	TerminateWorkflowExecutionResponse	TerminateWorkflowExecutionResponse

Returns

void

---

TriggerWorkflowRule

Ƭ TriggerWorkflowRule: Object

TriggerWorkflowRule allows to:

• trigger existing rule for a specific workflow execution;
• trigger rule for a specific workflow execution without creating a rule; This is useful for one-off operations.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ITriggerWorkflowRuleRequest
callback	TriggerWorkflowRuleCallback

Returns

void

▸ (request): Promise<TriggerWorkflowRuleResponse>

Parameters

Name	Type
request	ITriggerWorkflowRuleRequest

Returns

Promise<TriggerWorkflowRuleResponse>

Type declaration

Name	Type
name	"TriggerWorkflowRule"
path	"/temporal.api.workflowservice.v1.WorkflowService/TriggerWorkflowRule"
requestStream	undefined
requestType	"TriggerWorkflowRuleRequest"
responseStream	undefined
responseType	"TriggerWorkflowRuleResponse"

---

TriggerWorkflowRuleCallback

Ƭ TriggerWorkflowRuleCallback: (error: Error | null, response?: TriggerWorkflowRuleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#triggerWorkflowRule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	TriggerWorkflowRuleResponse	TriggerWorkflowRuleResponse

Returns

void

---

UnpauseActivity

Ƭ UnpauseActivity: Object

UnpauseActivity unpauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them will be unpaused.

If activity is not paused, this call will have no effect. If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag). Once the activity is unpaused, all timeout timers will be regenerated.

Flags: 'jitter': the activity will be scheduled at a random time within the jitter duration. 'reset_attempts': the number of attempts will be reset. 'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset.

Returns a NotFound error if there is no pending activity with the provided ID or type This API will be deprecated soon and replaced with a newer UnpauseActivityExecution that is better named and structured to work well for standalone activities.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUnpauseActivityRequest
callback	UnpauseActivityCallback

Returns

void

▸ (request): Promise<UnpauseActivityResponse>

Parameters

Name	Type
request	IUnpauseActivityRequest

Returns

Promise<UnpauseActivityResponse>

Type declaration

Name	Type
name	"UnpauseActivity"
path	"/temporal.api.workflowservice.v1.WorkflowService/UnpauseActivity"
requestStream	undefined
requestType	"UnpauseActivityRequest"
responseStream	undefined
responseType	"UnpauseActivityResponse"

---

UnpauseActivityCallback

Ƭ UnpauseActivityCallback: (error: Error | null, response?: UnpauseActivityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#unpauseActivity.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UnpauseActivityResponse	UnpauseActivityResponse

Returns

void

---

UnpauseActivityExecution

Ƭ UnpauseActivityExecution: Object

UnpauseActivityExecution unpauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity.

If activity is not paused, this call will have no effect. If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag). Once the activity is unpaused, all timeout timers will be regenerated.

Returns a NotFound error if there is no pending activity with the provided ID

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUnpauseActivityExecutionRequest
callback	UnpauseActivityExecutionCallback

Returns

void

▸ (request): Promise<UnpauseActivityExecutionResponse>

Parameters

Name	Type
request	IUnpauseActivityExecutionRequest

Returns

Promise<UnpauseActivityExecutionResponse>

Type declaration

Name	Type
name	"UnpauseActivityExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/UnpauseActivityExecution"
requestStream	undefined
requestType	"UnpauseActivityExecutionRequest"
responseStream	undefined
responseType	"UnpauseActivityExecutionResponse"

---

UnpauseActivityExecutionCallback

Ƭ UnpauseActivityExecutionCallback: (error: Error | null, response?: UnpauseActivityExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#unpauseActivityExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UnpauseActivityExecutionResponse	UnpauseActivityExecutionResponse

Returns

void

---

UnpauseWorkflowExecution

Ƭ UnpauseWorkflowExecution: Object

Note: This is an experimental API and the behavior may change in a future release. UnpauseWorkflowExecution unpauses a previously paused workflow execution specified in the request. Unpausing a workflow execution results in

• The workflow execution status changes to RUNNING and a new WORKFLOW_EXECUTION_UNPAUSED event is added to the history
• Workflow tasks and activity tasks are resumed.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUnpauseWorkflowExecutionRequest
callback	UnpauseWorkflowExecutionCallback

Returns

void

▸ (request): Promise<UnpauseWorkflowExecutionResponse>

Parameters

Name	Type
request	IUnpauseWorkflowExecutionRequest

Returns

Promise<UnpauseWorkflowExecutionResponse>

Type declaration

Name	Type
name	"UnpauseWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/UnpauseWorkflowExecution"
requestStream	undefined
requestType	"UnpauseWorkflowExecutionRequest"
responseStream	undefined
responseType	"UnpauseWorkflowExecutionResponse"

---

UnpauseWorkflowExecutionCallback

Ƭ UnpauseWorkflowExecutionCallback: (error: Error | null, response?: UnpauseWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#unpauseWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UnpauseWorkflowExecutionResponse	UnpauseWorkflowExecutionResponse

Returns

void

---

UpdateActivityExecutionOptions

Ƭ UpdateActivityExecutionOptions: Object

UpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID. This API can be used to target a workflow activity or a standalone activity.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateActivityExecutionOptionsRequest
callback	UpdateActivityExecutionOptionsCallback

Returns

void

▸ (request): Promise<UpdateActivityExecutionOptionsResponse>

Parameters

Name	Type
request	IUpdateActivityExecutionOptionsRequest

Returns

Promise<UpdateActivityExecutionOptionsResponse>

Type declaration

Name	Type
name	"UpdateActivityExecutionOptions"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateActivityExecutionOptions"
requestStream	undefined
requestType	"UpdateActivityExecutionOptionsRequest"
responseStream	undefined
responseType	"UpdateActivityExecutionOptionsResponse"

---

UpdateActivityExecutionOptionsCallback

Ƭ UpdateActivityExecutionOptionsCallback: (error: Error | null, response?: UpdateActivityExecutionOptionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateActivityExecutionOptions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateActivityExecutionOptionsResponse	UpdateActivityExecutionOptionsResponse

Returns

void

---

UpdateActivityOptions

Ƭ UpdateActivityOptions: Object

UpdateActivityOptions is called by the client to update the options of an activity by its ID or type. If there are multiple pending activities of the provided type - all of them will be updated. This API will be deprecated soon and replaced with a newer UpdateActivityExecutionOptions that is better named and structured to work well for standalone activities.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateActivityOptionsRequest
callback	UpdateActivityOptionsCallback

Returns

void

▸ (request): Promise<UpdateActivityOptionsResponse>

Parameters

Name	Type
request	IUpdateActivityOptionsRequest

Returns

Promise<UpdateActivityOptionsResponse>

Type declaration

Name	Type
name	"UpdateActivityOptions"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateActivityOptions"
requestStream	undefined
requestType	"UpdateActivityOptionsRequest"
responseStream	undefined
responseType	"UpdateActivityOptionsResponse"

---

UpdateActivityOptionsCallback

Ƭ UpdateActivityOptionsCallback: (error: Error | null, response?: UpdateActivityOptionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateActivityOptions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateActivityOptionsResponse	UpdateActivityOptionsResponse

Returns

void

---

UpdateNamespace

Ƭ UpdateNamespace: Object

UpdateNamespace is used to update the information and configuration of a registered namespace.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateNamespaceRequest
callback	UpdateNamespaceCallback

Returns

void

▸ (request): Promise<UpdateNamespaceResponse>

Parameters

Name	Type
request	IUpdateNamespaceRequest

Returns

Promise<UpdateNamespaceResponse>

Type declaration

Name	Type
name	"UpdateNamespace"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateNamespace"
requestStream	undefined
requestType	"UpdateNamespaceRequest"
responseStream	undefined
responseType	"UpdateNamespaceResponse"

---

UpdateNamespaceCallback

Ƭ UpdateNamespaceCallback: (error: Error | null, response?: UpdateNamespaceResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateNamespace.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateNamespaceResponse	UpdateNamespaceResponse

Returns

void

---

UpdateSchedule

Ƭ UpdateSchedule: Object

Changes the configuration or state of an existing schedule.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateScheduleRequest
callback	UpdateScheduleCallback

Returns

void

▸ (request): Promise<UpdateScheduleResponse>

Parameters

Name	Type
request	IUpdateScheduleRequest

Returns

Promise<UpdateScheduleResponse>

Type declaration

Name	Type
name	"UpdateSchedule"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateSchedule"
requestStream	undefined
requestType	"UpdateScheduleRequest"
responseStream	undefined
responseType	"UpdateScheduleResponse"

---

UpdateScheduleCallback

Ƭ UpdateScheduleCallback: (error: Error | null, response?: UpdateScheduleResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateSchedule.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateScheduleResponse	UpdateScheduleResponse

Returns

void

---

UpdateTaskQueueConfig

Ƭ UpdateTaskQueueConfig: Object

Updates task queue configuration. For the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit, which uncouples the rate limit from the worker lifecycle. If the overall queue rate limit is unset, the worker-set rate limit takes effect.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateTaskQueueConfigRequest
callback	UpdateTaskQueueConfigCallback

Returns

void

▸ (request): Promise<UpdateTaskQueueConfigResponse>

Parameters

Name	Type
request	IUpdateTaskQueueConfigRequest

Returns

Promise<UpdateTaskQueueConfigResponse>

Type declaration

Name	Type
name	"UpdateTaskQueueConfig"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateTaskQueueConfig"
requestStream	undefined
requestType	"UpdateTaskQueueConfigRequest"
responseStream	undefined
responseType	"UpdateTaskQueueConfigResponse"

---

UpdateTaskQueueConfigCallback

Ƭ UpdateTaskQueueConfigCallback: (error: Error | null, response?: UpdateTaskQueueConfigResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateTaskQueueConfig.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateTaskQueueConfigResponse	UpdateTaskQueueConfigResponse

Returns

void

---

UpdateWorkerBuildIdCompatibility

Ƭ UpdateWorkerBuildIdCompatibility: Object

Deprecated. Use UpdateWorkerVersioningRules. Will be removed in server version v1.32.0.

Allows users to specify sets of worker build id versions on a per task queue basis. Versions are ordered, and may be either compatible with some extant version, or a new incompatible version, forming sets of ids which are incompatible with each other, but whose contained members are compatible with one another.

A single build id may be mapped to multiple task queues using this API for cases where a single process hosts multiple workers.

To query which workers can be retired, use the GetWorkerTaskReachability API.

NOTE: The number of task queues mapped to a single build id is limited by the limit.taskQueuesPerBuildId (default is 20), if this limit is exceeded this API will error with a FailedPrecondition.

(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkerBuildIdCompatibilityRequest
callback	UpdateWorkerBuildIdCompatibilityCallback

Returns

void

▸ (request): Promise<UpdateWorkerBuildIdCompatibilityResponse>

Parameters

Name	Type
request	IUpdateWorkerBuildIdCompatibilityRequest

Returns

Promise<UpdateWorkerBuildIdCompatibilityResponse>

Type declaration

Name	Type
name	"UpdateWorkerBuildIdCompatibility"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerBuildIdCompatibility"
requestStream	undefined
requestType	"UpdateWorkerBuildIdCompatibilityRequest"
responseStream	undefined
responseType	"UpdateWorkerBuildIdCompatibilityResponse"

---

UpdateWorkerBuildIdCompatibilityCallback

Ƭ UpdateWorkerBuildIdCompatibilityCallback: (error: Error | null, response?: UpdateWorkerBuildIdCompatibilityResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerBuildIdCompatibility.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkerBuildIdCompatibilityResponse	UpdateWorkerBuildIdCompatibilityResponse

Returns

void

---

UpdateWorkerConfig

Ƭ UpdateWorkerConfig: Object

UpdateWorkerConfig updates the worker configuration of one or more workers. Can be used to partially update the worker configuration. Can be used to update the configuration of multiple workers.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkerConfigRequest
callback	UpdateWorkerConfigCallback

Returns

void

▸ (request): Promise<UpdateWorkerConfigResponse>

Parameters

Name	Type
request	IUpdateWorkerConfigRequest

Returns

Promise<UpdateWorkerConfigResponse>

Type declaration

Name	Type
name	"UpdateWorkerConfig"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerConfig"
requestStream	undefined
requestType	"UpdateWorkerConfigRequest"
responseStream	undefined
responseType	"UpdateWorkerConfigResponse"

---

UpdateWorkerConfigCallback

Ƭ UpdateWorkerConfigCallback: (error: Error | null, response?: UpdateWorkerConfigResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerConfig.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkerConfigResponse	UpdateWorkerConfigResponse

Returns

void

---

UpdateWorkerDeploymentVersionComputeConfig

Ƭ UpdateWorkerDeploymentVersionComputeConfig: Object

Updates the compute config attached to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkerDeploymentVersionComputeConfigRequest
callback	UpdateWorkerDeploymentVersionComputeConfigCallback

Returns

void

▸ (request): Promise<UpdateWorkerDeploymentVersionComputeConfigResponse>

Parameters

Name	Type
request	IUpdateWorkerDeploymentVersionComputeConfigRequest

Returns

Promise<UpdateWorkerDeploymentVersionComputeConfigResponse>

Type declaration

Name	Type
name	"UpdateWorkerDeploymentVersionComputeConfig"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerDeploymentVersionComputeConfig"
requestStream	undefined
requestType	"UpdateWorkerDeploymentVersionComputeConfigRequest"
responseStream	undefined
responseType	"UpdateWorkerDeploymentVersionComputeConfigResponse"

---

UpdateWorkerDeploymentVersionComputeConfigCallback

Ƭ UpdateWorkerDeploymentVersionComputeConfigCallback: (error: Error | null, response?: UpdateWorkerDeploymentVersionComputeConfigResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerDeploymentVersionComputeConfig.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkerDeploymentVersionComputeConfigResponse	UpdateWorkerDeploymentVersionComputeConfigResponse

Returns

void

---

UpdateWorkerDeploymentVersionMetadata

Ƭ UpdateWorkerDeploymentVersionMetadata: Object

Updates the user-given metadata attached to a Worker Deployment Version.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkerDeploymentVersionMetadataRequest
callback	UpdateWorkerDeploymentVersionMetadataCallback

Returns

void

▸ (request): Promise<UpdateWorkerDeploymentVersionMetadataResponse>

Parameters

Name	Type
request	IUpdateWorkerDeploymentVersionMetadataRequest

Returns

Promise<UpdateWorkerDeploymentVersionMetadataResponse>

Type declaration

Name	Type
name	"UpdateWorkerDeploymentVersionMetadata"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerDeploymentVersionMetadata"
requestStream	undefined
requestType	"UpdateWorkerDeploymentVersionMetadataRequest"
responseStream	undefined
responseType	"UpdateWorkerDeploymentVersionMetadataResponse"

---

UpdateWorkerDeploymentVersionMetadataCallback

Ƭ UpdateWorkerDeploymentVersionMetadataCallback: (error: Error | null, response?: UpdateWorkerDeploymentVersionMetadataResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerDeploymentVersionMetadata.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkerDeploymentVersionMetadataResponse	UpdateWorkerDeploymentVersionMetadataResponse

Returns

void

---

UpdateWorkerVersioningRules

Ƭ UpdateWorkerVersioningRules: Object

Use this API to manage Worker Versioning Rules for a given Task Queue. There are two types of rules: Build ID Assignment rules and Compatible Build ID Redirect rules.

Assignment rules determine how to assign new executions to a Build IDs. Their primary use case is to specify the latest Build ID but they have powerful features for gradual rollout of a new Build ID.

Once a workflow execution is assigned to a Build ID and it completes its first Workflow Task, the workflow stays on the assigned Build ID regardless of changes in assignment rules. This eliminates the need for compatibility between versions when you only care about using the new version for new workflows and let existing workflows finish in their own version.

Activities, Child Workflows and Continue-as-New executions have the option to inherit the Build ID of their parent/previous workflow or use the latest assignment rules to independently select a Build ID.

Redirect rules should only be used when you want to move workflows and activities assigned to one Build ID (source) to another compatible Build ID (target). You are responsible to make sure the target Build ID of a redirect rule is able to process event histories made by the source Build ID by using Patching or other means.

Will be removed in server version v1.32.0. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkerVersioningRulesRequest
callback	UpdateWorkerVersioningRulesCallback

Returns

void

▸ (request): Promise<UpdateWorkerVersioningRulesResponse>

Parameters

Name	Type
request	IUpdateWorkerVersioningRulesRequest

Returns

Promise<UpdateWorkerVersioningRulesResponse>

Type declaration

Name	Type
name	"UpdateWorkerVersioningRules"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerVersioningRules"
requestStream	undefined
requestType	"UpdateWorkerVersioningRulesRequest"
responseStream	undefined
responseType	"UpdateWorkerVersioningRulesResponse"

---

UpdateWorkerVersioningRulesCallback

Ƭ UpdateWorkerVersioningRulesCallback: (error: Error | null, response?: UpdateWorkerVersioningRulesResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerVersioningRules.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkerVersioningRulesResponse	UpdateWorkerVersioningRulesResponse

Returns

void

---

UpdateWorkflowExecution

Ƭ UpdateWorkflowExecution: Object

Invokes the specified Update function on user Workflow code.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkflowExecutionRequest
callback	UpdateWorkflowExecutionCallback

Returns

void

▸ (request): Promise<UpdateWorkflowExecutionResponse>

Parameters

Name	Type
request	IUpdateWorkflowExecutionRequest

Returns

Promise<UpdateWorkflowExecutionResponse>

Type declaration

Name	Type
name	"UpdateWorkflowExecution"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkflowExecution"
requestStream	undefined
requestType	"UpdateWorkflowExecutionRequest"
responseStream	undefined
responseType	"UpdateWorkflowExecutionResponse"

---

UpdateWorkflowExecutionCallback

Ƭ UpdateWorkflowExecutionCallback: (error: Error | null, response?: UpdateWorkflowExecutionResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkflowExecution.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkflowExecutionResponse	UpdateWorkflowExecutionResponse

Returns

void

---

UpdateWorkflowExecutionOptions

Ƭ UpdateWorkflowExecutionOptions: Object

UpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateWorkflowExecutionOptionsRequest
callback	UpdateWorkflowExecutionOptionsCallback

Returns

void

▸ (request): Promise<UpdateWorkflowExecutionOptionsResponse>

Parameters

Name	Type
request	IUpdateWorkflowExecutionOptionsRequest

Returns

Promise<UpdateWorkflowExecutionOptionsResponse>

Type declaration

Name	Type
name	"UpdateWorkflowExecutionOptions"
path	"/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkflowExecutionOptions"
requestStream	undefined
requestType	"UpdateWorkflowExecutionOptionsRequest"
responseStream	undefined
responseType	"UpdateWorkflowExecutionOptionsResponse"

---

UpdateWorkflowExecutionOptionsCallback

Ƭ UpdateWorkflowExecutionOptionsCallback: (error: Error | null, response?: UpdateWorkflowExecutionOptionsResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkflowExecutionOptions.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateWorkflowExecutionOptionsResponse	UpdateWorkflowExecutionOptionsResponse

Returns

void

---

ValidateWorkerDeploymentVersionComputeConfig

Ƭ ValidateWorkerDeploymentVersionComputeConfig: Object

Validates the compute config without attaching it to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IValidateWorkerDeploymentVersionComputeConfigRequest
callback	ValidateWorkerDeploymentVersionComputeConfigCallback

Returns

void

▸ (request): Promise<ValidateWorkerDeploymentVersionComputeConfigResponse>

Parameters

Name	Type
request	IValidateWorkerDeploymentVersionComputeConfigRequest

Returns

Promise<ValidateWorkerDeploymentVersionComputeConfigResponse>

Type declaration

Name	Type
name	"ValidateWorkerDeploymentVersionComputeConfig"
path	"/temporal.api.workflowservice.v1.WorkflowService/ValidateWorkerDeploymentVersionComputeConfig"
requestStream	undefined
requestType	"ValidateWorkerDeploymentVersionComputeConfigRequest"
responseStream	undefined
responseType	"ValidateWorkerDeploymentVersionComputeConfigResponse"

---

ValidateWorkerDeploymentVersionComputeConfigCallback

Ƭ ValidateWorkerDeploymentVersionComputeConfigCallback: (error: Error | null, response?: ValidateWorkerDeploymentVersionComputeConfigResponse) => void

Callback as used by temporal.api.workflowservice.v1.WorkflowService#validateWorkerDeploymentVersionComputeConfig.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ValidateWorkerDeploymentVersionComputeConfigResponse	ValidateWorkerDeploymentVersionComputeConfigResponse

Returns

void