Skip to main content

WorkflowService

Type Aliases​

CountActivityExecutions()​

CountActivityExecutions = void

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

Call Signature​

CountActivityExecutions(request, callback): void

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

Parameters​
request​

ICountActivityExecutionsRequest

callback​

CountActivityExecutionsCallback

Returns​

void

Call Signature​

CountActivityExecutions(request): Promise<CountActivityExecutionsResponse>

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

Parameters​
request​

ICountActivityExecutionsRequest

Returns​

Promise<CountActivityExecutionsResponse>

Properties​

name​

readonly name: "CountActivityExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CountActivityExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CountActivityExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CountActivityExecutionsResponse"

CountActivityExecutionsCallback​

CountActivityExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CountActivityExecutionsResponse

CountActivityExecutionsResponse

Returns​

void

CountNexusOperationExecutions()​

CountNexusOperationExecutions = void

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

Call Signature​

CountNexusOperationExecutions(request, callback): void

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

Parameters​
request​

ICountNexusOperationExecutionsRequest

callback​

CountNexusOperationExecutionsCallback

Returns​

void

Call Signature​

CountNexusOperationExecutions(request): Promise<CountNexusOperationExecutionsResponse>

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

Parameters​
request​

ICountNexusOperationExecutionsRequest

Returns​

Promise<CountNexusOperationExecutionsResponse>

Properties​

name​

readonly name: "CountNexusOperationExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CountNexusOperationExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CountNexusOperationExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CountNexusOperationExecutionsResponse"

CountNexusOperationExecutionsCallback​

CountNexusOperationExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CountNexusOperationExecutionsResponse

CountNexusOperationExecutionsResponse

Returns​

void

CountSchedules()​

CountSchedules = void

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

Call Signature​

CountSchedules(request, callback): void

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

Parameters​
request​

ICountSchedulesRequest

callback​

CountSchedulesCallback

Returns​

void

Call Signature​

CountSchedules(request): Promise<CountSchedulesResponse>

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

Parameters​
request​

ICountSchedulesRequest

Returns​

Promise<CountSchedulesResponse>

Properties​

name​

readonly name: "CountSchedules"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CountSchedules"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CountSchedulesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CountSchedulesResponse"

CountSchedulesCallback​

CountSchedulesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CountSchedulesResponse

CountSchedulesResponse

Returns​

void

CountWorkers()​

CountWorkers = void

CountWorkers counts the number of workers in a specific namespace.

Call Signature​

CountWorkers(request, callback): void

CountWorkers counts the number of workers in a specific namespace.

Parameters​
request​

ICountWorkersRequest

callback​

CountWorkersCallback

Returns​

void

Call Signature​

CountWorkers(request): Promise<CountWorkersResponse>

CountWorkers counts the number of workers in a specific namespace.

Parameters​
request​

ICountWorkersRequest

Returns​

Promise<CountWorkersResponse>

Properties​

name​

readonly name: "CountWorkers"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CountWorkers"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CountWorkersRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CountWorkersResponse"

CountWorkersCallback​

CountWorkersCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CountWorkersResponse

CountWorkersResponse

Returns​

void

CountWorkflowExecutions()​

CountWorkflowExecutions = void

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

Call Signature​

CountWorkflowExecutions(request, callback): void

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

Parameters​
request​

ICountWorkflowExecutionsRequest

callback​

CountWorkflowExecutionsCallback

Returns​

void

Call Signature​

CountWorkflowExecutions(request): Promise<CountWorkflowExecutionsResponse>

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

Parameters​
request​

ICountWorkflowExecutionsRequest

Returns​

Promise<CountWorkflowExecutionsResponse>

Properties​

name​

readonly name: "CountWorkflowExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CountWorkflowExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CountWorkflowExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CountWorkflowExecutionsResponse"

CountWorkflowExecutionsCallback​

CountWorkflowExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CountWorkflowExecutionsResponse

CountWorkflowExecutionsResponse

Returns​

void

CreateSchedule()​

CreateSchedule = void

Creates a new schedule.

Call Signature​

CreateSchedule(request, callback): void

Creates a new schedule.

Parameters​
request​

ICreateScheduleRequest

callback​

CreateScheduleCallback

Returns​

void

Call Signature​

CreateSchedule(request): Promise<CreateScheduleResponse>

Creates a new schedule.

Parameters​
request​

ICreateScheduleRequest

Returns​

Promise<CreateScheduleResponse>

Properties​

name​

readonly name: "CreateSchedule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CreateSchedule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateScheduleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateScheduleResponse"

CreateScheduleCallback​

CreateScheduleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateScheduleResponse

CreateScheduleResponse

Returns​

void

CreateWorkerDeployment()​

CreateWorkerDeployment = void

Creates a new Worker Deployment.

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

Call Signature​

CreateWorkerDeployment(request, callback): void

Creates a new Worker Deployment.

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

Parameters​
request​

ICreateWorkerDeploymentRequest

callback​

CreateWorkerDeploymentCallback

Returns​

void

Call Signature​

CreateWorkerDeployment(request): Promise<CreateWorkerDeploymentResponse>

Creates a new Worker Deployment.

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

Parameters​
request​

ICreateWorkerDeploymentRequest

Returns​

Promise<CreateWorkerDeploymentResponse>

Properties​

name​

readonly name: "CreateWorkerDeployment"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CreateWorkerDeployment"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateWorkerDeploymentRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateWorkerDeploymentResponse"

CreateWorkerDeploymentCallback​

CreateWorkerDeploymentCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateWorkerDeploymentResponse

CreateWorkerDeploymentResponse

Returns​

void

CreateWorkerDeploymentVersion()​

CreateWorkerDeploymentVersion = void

Creates a new Worker Deployment Version.

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

Call Signature​

CreateWorkerDeploymentVersion(request, callback): void

Creates a new Worker Deployment Version.

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

Parameters​
request​

ICreateWorkerDeploymentVersionRequest

callback​

CreateWorkerDeploymentVersionCallback

Returns​

void

Call Signature​

CreateWorkerDeploymentVersion(request): Promise<CreateWorkerDeploymentVersionResponse>

Creates a new Worker Deployment Version.

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

Parameters​
request​

ICreateWorkerDeploymentVersionRequest

Returns​

Promise<CreateWorkerDeploymentVersionResponse>

Properties​

name​

readonly name: "CreateWorkerDeploymentVersion"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CreateWorkerDeploymentVersion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateWorkerDeploymentVersionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateWorkerDeploymentVersionResponse"

CreateWorkerDeploymentVersionCallback​

CreateWorkerDeploymentVersionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateWorkerDeploymentVersionResponse

CreateWorkerDeploymentVersionResponse

Returns​

void

CreateWorkflowRule()​

CreateWorkflowRule = void

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​

CreateWorkflowRule(request, callback): void

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.

Parameters​
request​

ICreateWorkflowRuleRequest

callback​

CreateWorkflowRuleCallback

Returns​

void

Call Signature​

CreateWorkflowRule(request): Promise<CreateWorkflowRuleResponse>

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.

Parameters​
request​

ICreateWorkflowRuleRequest

Returns​

Promise<CreateWorkflowRuleResponse>

Properties​

name​

readonly name: "CreateWorkflowRule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/CreateWorkflowRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateWorkflowRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateWorkflowRuleResponse"

CreateWorkflowRuleCallback​

CreateWorkflowRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateWorkflowRuleResponse

CreateWorkflowRuleResponse

Returns​

void

DeleteActivityExecution()​

DeleteActivityExecution = void

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​

DeleteActivityExecution(request, callback): void

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. --)

Parameters​
request​

IDeleteActivityExecutionRequest

callback​

DeleteActivityExecutionCallback

Returns​

void

Call Signature​

DeleteActivityExecution(request): Promise<DeleteActivityExecutionResponse>

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. --)

Parameters​
request​

IDeleteActivityExecutionRequest

Returns​

Promise<DeleteActivityExecutionResponse>

Properties​

name​

readonly name: "DeleteActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteActivityExecutionResponse"

DeleteActivityExecutionCallback​

DeleteActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteActivityExecutionResponse

DeleteActivityExecutionResponse

Returns​

void

DeleteNexusOperationExecution()​

DeleteNexusOperationExecution = void

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​

DeleteNexusOperationExecution(request, callback): void

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. --)

Parameters​
request​

IDeleteNexusOperationExecutionRequest

callback​

DeleteNexusOperationExecutionCallback

Returns​

void

Call Signature​

DeleteNexusOperationExecution(request): Promise<DeleteNexusOperationExecutionResponse>

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. --)

Parameters​
request​

IDeleteNexusOperationExecutionRequest

Returns​

Promise<DeleteNexusOperationExecutionResponse>

Properties​

name​

readonly name: "DeleteNexusOperationExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteNexusOperationExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNexusOperationExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNexusOperationExecutionResponse"

DeleteNexusOperationExecutionCallback​

DeleteNexusOperationExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNexusOperationExecutionResponse

DeleteNexusOperationExecutionResponse

Returns​

void

DeleteSchedule()​

DeleteSchedule = void

Deletes a schedule, removing it from the system.

Call Signature​

DeleteSchedule(request, callback): void

Deletes a schedule, removing it from the system.

Parameters​
request​

IDeleteScheduleRequest

callback​

DeleteScheduleCallback

Returns​

void

Call Signature​

DeleteSchedule(request): Promise<DeleteScheduleResponse>

Deletes a schedule, removing it from the system.

Parameters​
request​

IDeleteScheduleRequest

Returns​

Promise<DeleteScheduleResponse>

Properties​

name​

readonly name: "DeleteSchedule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteSchedule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteScheduleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteScheduleResponse"

DeleteScheduleCallback​

DeleteScheduleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteScheduleResponse

DeleteScheduleResponse

Returns​

void

DeleteWorkerDeployment()​

DeleteWorkerDeployment = void

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

Call Signature​

DeleteWorkerDeployment(request, callback): void

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

Parameters​
request​

IDeleteWorkerDeploymentRequest

callback​

DeleteWorkerDeploymentCallback

Returns​

void

Call Signature​

DeleteWorkerDeployment(request): Promise<DeleteWorkerDeploymentResponse>

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

Parameters​
request​

IDeleteWorkerDeploymentRequest

Returns​

Promise<DeleteWorkerDeploymentResponse>

Properties​

name​

readonly name: "DeleteWorkerDeployment"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkerDeployment"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteWorkerDeploymentRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteWorkerDeploymentResponse"

DeleteWorkerDeploymentCallback​

DeleteWorkerDeploymentCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteWorkerDeploymentResponse

DeleteWorkerDeploymentResponse

Returns​

void

DeleteWorkerDeploymentVersion()​

DeleteWorkerDeploymentVersion = void

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​

DeleteWorkerDeploymentVersion(request, callback): void

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.
Parameters​
request​

IDeleteWorkerDeploymentVersionRequest

callback​

DeleteWorkerDeploymentVersionCallback

Returns​

void

Call Signature​

DeleteWorkerDeploymentVersion(request): Promise<DeleteWorkerDeploymentVersionResponse>

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.
Parameters​
request​

IDeleteWorkerDeploymentVersionRequest

Returns​

Promise<DeleteWorkerDeploymentVersionResponse>

Properties​

name​

readonly name: "DeleteWorkerDeploymentVersion"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkerDeploymentVersion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteWorkerDeploymentVersionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteWorkerDeploymentVersionResponse"

DeleteWorkerDeploymentVersionCallback​

DeleteWorkerDeploymentVersionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteWorkerDeploymentVersionResponse

DeleteWorkerDeploymentVersionResponse

Returns​

void

DeleteWorkflowExecution()​

DeleteWorkflowExecution = void

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​

DeleteWorkflowExecution(request, callback): void

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. --)

Parameters​
request​

IDeleteWorkflowExecutionRequest

callback​

DeleteWorkflowExecutionCallback

Returns​

void

Call Signature​

DeleteWorkflowExecution(request): Promise<DeleteWorkflowExecutionResponse>

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. --)

Parameters​
request​

IDeleteWorkflowExecutionRequest

Returns​

Promise<DeleteWorkflowExecutionResponse>

Properties​

name​

readonly name: "DeleteWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteWorkflowExecutionResponse"

DeleteWorkflowExecutionCallback​

DeleteWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteWorkflowExecutionResponse

DeleteWorkflowExecutionResponse

Returns​

void

DeleteWorkflowRule()​

DeleteWorkflowRule = void

Delete rule by rule id

Call Signature​

DeleteWorkflowRule(request, callback): void

Delete rule by rule id

Parameters​
request​

IDeleteWorkflowRuleRequest

callback​

DeleteWorkflowRuleCallback

Returns​

void

Call Signature​

DeleteWorkflowRule(request): Promise<DeleteWorkflowRuleResponse>

Delete rule by rule id

Parameters​
request​

IDeleteWorkflowRuleRequest

Returns​

Promise<DeleteWorkflowRuleResponse>

Properties​

name​

readonly name: "DeleteWorkflowRule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeleteWorkflowRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteWorkflowRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteWorkflowRuleResponse"

DeleteWorkflowRuleCallback​

DeleteWorkflowRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteWorkflowRuleResponse

DeleteWorkflowRuleResponse

Returns​

void

DeprecateNamespace()​

DeprecateNamespace = void

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​

DeprecateNamespace(request, callback): void

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 --)

Parameters​
request​

IDeprecateNamespaceRequest

callback​

DeprecateNamespaceCallback

Returns​

void

Call Signature​

DeprecateNamespace(request): Promise<DeprecateNamespaceResponse>

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 --)

Parameters​
request​

IDeprecateNamespaceRequest

Returns​

Promise<DeprecateNamespaceResponse>

Properties​

name​

readonly name: "DeprecateNamespace"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DeprecateNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeprecateNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeprecateNamespaceResponse"

DeprecateNamespaceCallback​

DeprecateNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeprecateNamespaceResponse

DeprecateNamespaceResponse

Returns​

void

DescribeActivityExecution()​

DescribeActivityExecution = void

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​

DescribeActivityExecution(request, callback): void

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).
Parameters​
request​

IDescribeActivityExecutionRequest

callback​

DescribeActivityExecutionCallback

Returns​

void

Call Signature​

DescribeActivityExecution(request): Promise<DescribeActivityExecutionResponse>

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).
Parameters​
request​

IDescribeActivityExecutionRequest

Returns​

Promise<DescribeActivityExecutionResponse>

Properties​

name​

readonly name: "DescribeActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeActivityExecutionResponse"

DescribeActivityExecutionCallback​

DescribeActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeActivityExecutionResponse

DescribeActivityExecutionResponse

Returns​

void

DescribeBatchOperation()​

DescribeBatchOperation = void

DescribeBatchOperation returns the information about a batch operation

Call Signature​

DescribeBatchOperation(request, callback): void

DescribeBatchOperation returns the information about a batch operation

Parameters​
request​

IDescribeBatchOperationRequest

callback​

DescribeBatchOperationCallback

Returns​

void

Call Signature​

DescribeBatchOperation(request): Promise<DescribeBatchOperationResponse>

DescribeBatchOperation returns the information about a batch operation

Parameters​
request​

IDescribeBatchOperationRequest

Returns​

Promise<DescribeBatchOperationResponse>

Properties​

name​

readonly name: "DescribeBatchOperation"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeBatchOperation"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeBatchOperationRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeBatchOperationResponse"

DescribeBatchOperationCallback​

DescribeBatchOperationCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeBatchOperationResponse

DescribeBatchOperationResponse

Returns​

void

DescribeDeployment()​

DescribeDeployment = void

Describes a worker deployment. Deprecated. Replaced with DescribeWorkerDeploymentVersion.

Call Signature​

DescribeDeployment(request, callback): void

Describes a worker deployment. Deprecated. Replaced with DescribeWorkerDeploymentVersion.

Parameters​
request​

IDescribeDeploymentRequest

callback​

DescribeDeploymentCallback

Returns​

void

Call Signature​

DescribeDeployment(request): Promise<DescribeDeploymentResponse>

Describes a worker deployment. Deprecated. Replaced with DescribeWorkerDeploymentVersion.

Parameters​
request​

IDescribeDeploymentRequest

Returns​

Promise<DescribeDeploymentResponse>

Properties​

name​

readonly name: "DescribeDeployment"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeDeployment"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeDeploymentRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeDeploymentResponse"

DescribeDeploymentCallback​

DescribeDeploymentCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeDeploymentResponse

DescribeDeploymentResponse

Returns​

void

DescribeNamespace()​

DescribeNamespace = void

DescribeNamespace returns the information and configuration for a registered namespace.

Call Signature​

DescribeNamespace(request, callback): void

DescribeNamespace returns the information and configuration for a registered namespace.

Parameters​
request​

IDescribeNamespaceRequest

callback​

DescribeNamespaceCallback

Returns​

void

Call Signature​

DescribeNamespace(request): Promise<DescribeNamespaceResponse>

DescribeNamespace returns the information and configuration for a registered namespace.

Parameters​
request​

IDescribeNamespaceRequest

Returns​

Promise<DescribeNamespaceResponse>

Properties​

name​

readonly name: "DescribeNamespace"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeNamespaceResponse"

DescribeNamespaceCallback​

DescribeNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeNamespaceResponse

DescribeNamespaceResponse

Returns​

void

DescribeNexusOperationExecution()​

DescribeNexusOperationExecution = void

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​

DescribeNexusOperationExecution(request, callback): void

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).
Parameters​
request​

IDescribeNexusOperationExecutionRequest

callback​

DescribeNexusOperationExecutionCallback

Returns​

void

Call Signature​

DescribeNexusOperationExecution(request): Promise<DescribeNexusOperationExecutionResponse>

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).
Parameters​
request​

IDescribeNexusOperationExecutionRequest

Returns​

Promise<DescribeNexusOperationExecutionResponse>

Properties​

name​

readonly name: "DescribeNexusOperationExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeNexusOperationExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeNexusOperationExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeNexusOperationExecutionResponse"

DescribeNexusOperationExecutionCallback​

DescribeNexusOperationExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeNexusOperationExecutionResponse

DescribeNexusOperationExecutionResponse

Returns​

void

DescribeSchedule()​

DescribeSchedule = void

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

Call Signature​

DescribeSchedule(request, callback): void

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

Parameters​
request​

IDescribeScheduleRequest

callback​

DescribeScheduleCallback

Returns​

void

Call Signature​

DescribeSchedule(request): Promise<DescribeScheduleResponse>

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

Parameters​
request​

IDescribeScheduleRequest

Returns​

Promise<DescribeScheduleResponse>

Properties​

name​

readonly name: "DescribeSchedule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeSchedule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeScheduleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeScheduleResponse"

DescribeScheduleCallback​

DescribeScheduleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeScheduleResponse

DescribeScheduleResponse

Returns​

void

DescribeTaskQueue()​

DescribeTaskQueue = void

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​

DescribeTaskQueue(request, callback): void

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
Parameters​
request​

IDescribeTaskQueueRequest

callback​

DescribeTaskQueueCallback

Returns​

void

Call Signature​

DescribeTaskQueue(request): Promise<DescribeTaskQueueResponse>

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
Parameters​
request​

IDescribeTaskQueueRequest

Returns​

Promise<DescribeTaskQueueResponse>

Properties​

name​

readonly name: "DescribeTaskQueue"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeTaskQueue"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeTaskQueueRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeTaskQueueResponse"

DescribeTaskQueueCallback​

DescribeTaskQueueCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeTaskQueueResponse

DescribeTaskQueueResponse

Returns​

void

DescribeWorker()​

DescribeWorker = void

DescribeWorker returns information about the specified worker.

Call Signature​

DescribeWorker(request, callback): void

DescribeWorker returns information about the specified worker.

Parameters​
request​

IDescribeWorkerRequest

callback​

DescribeWorkerCallback

Returns​

void

Call Signature​

DescribeWorker(request): Promise<DescribeWorkerResponse>

DescribeWorker returns information about the specified worker.

Parameters​
request​

IDescribeWorkerRequest

Returns​

Promise<DescribeWorkerResponse>

Properties​

name​

readonly name: "DescribeWorker"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeWorker"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeWorkerRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeWorkerResponse"

DescribeWorkerCallback​

DescribeWorkerCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeWorkerResponse

DescribeWorkerResponse

Returns​

void

DescribeWorkerDeployment()​

DescribeWorkerDeployment = void

Describes a Worker Deployment.

Call Signature​

DescribeWorkerDeployment(request, callback): void

Describes a Worker Deployment.

Parameters​
request​

IDescribeWorkerDeploymentRequest

callback​

DescribeWorkerDeploymentCallback

Returns​

void

Call Signature​

DescribeWorkerDeployment(request): Promise<DescribeWorkerDeploymentResponse>

Describes a Worker Deployment.

Parameters​
request​

IDescribeWorkerDeploymentRequest

Returns​

Promise<DescribeWorkerDeploymentResponse>

Properties​

name​

readonly name: "DescribeWorkerDeployment"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkerDeployment"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeWorkerDeploymentRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeWorkerDeploymentResponse"

DescribeWorkerDeploymentCallback​

DescribeWorkerDeploymentCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeWorkerDeploymentResponse

DescribeWorkerDeploymentResponse

Returns​

void

DescribeWorkerDeploymentVersion()​

DescribeWorkerDeploymentVersion = void

Describes a worker deployment version.

Call Signature​

DescribeWorkerDeploymentVersion(request, callback): void

Describes a worker deployment version.

Parameters​
request​

IDescribeWorkerDeploymentVersionRequest

callback​

DescribeWorkerDeploymentVersionCallback

Returns​

void

Call Signature​

DescribeWorkerDeploymentVersion(request): Promise<DescribeWorkerDeploymentVersionResponse>

Describes a worker deployment version.

Parameters​
request​

IDescribeWorkerDeploymentVersionRequest

Returns​

Promise<DescribeWorkerDeploymentVersionResponse>

Properties​

name​

readonly name: "DescribeWorkerDeploymentVersion"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkerDeploymentVersion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeWorkerDeploymentVersionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeWorkerDeploymentVersionResponse"

DescribeWorkerDeploymentVersionCallback​

DescribeWorkerDeploymentVersionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeWorkerDeploymentVersionResponse

DescribeWorkerDeploymentVersionResponse

Returns​

void

DescribeWorkflowExecution()​

DescribeWorkflowExecution = void

DescribeWorkflowExecution returns information about the specified workflow execution.

Call Signature​

DescribeWorkflowExecution(request, callback): void

DescribeWorkflowExecution returns information about the specified workflow execution.

Parameters​
request​

IDescribeWorkflowExecutionRequest

callback​

DescribeWorkflowExecutionCallback

Returns​

void

Call Signature​

DescribeWorkflowExecution(request): Promise<DescribeWorkflowExecutionResponse>

DescribeWorkflowExecution returns information about the specified workflow execution.

Parameters​
request​

IDescribeWorkflowExecutionRequest

Returns​

Promise<DescribeWorkflowExecutionResponse>

Properties​

name​

readonly name: "DescribeWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeWorkflowExecutionResponse"

DescribeWorkflowExecutionCallback​

DescribeWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeWorkflowExecutionResponse

DescribeWorkflowExecutionResponse

Returns​

void

DescribeWorkflowRule()​

DescribeWorkflowRule = void

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​

DescribeWorkflowRule(request, callback): void

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

Parameters​
request​

IDescribeWorkflowRuleRequest

callback​

DescribeWorkflowRuleCallback

Returns​

void

Call Signature​

DescribeWorkflowRule(request): Promise<DescribeWorkflowRuleResponse>

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

Parameters​
request​

IDescribeWorkflowRuleRequest

Returns​

Promise<DescribeWorkflowRuleResponse>

Properties​

name​

readonly name: "DescribeWorkflowRule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/DescribeWorkflowRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DescribeWorkflowRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DescribeWorkflowRuleResponse"

DescribeWorkflowRuleCallback​

DescribeWorkflowRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DescribeWorkflowRuleResponse

DescribeWorkflowRuleResponse

Returns​

void

ExecuteMultiOperation()​

ExecuteMultiOperation = void

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​

ExecuteMultiOperation(request, callback): void

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. --)

Parameters​
request​

IExecuteMultiOperationRequest

callback​

ExecuteMultiOperationCallback

Returns​

void

Call Signature​

ExecuteMultiOperation(request): Promise<ExecuteMultiOperationResponse>

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. --)

Parameters​
request​

IExecuteMultiOperationRequest

Returns​

Promise<ExecuteMultiOperationResponse>

Properties​

name​

readonly name: "ExecuteMultiOperation"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ExecuteMultiOperation"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ExecuteMultiOperationRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ExecuteMultiOperationResponse"

ExecuteMultiOperationCallback​

ExecuteMultiOperationCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ExecuteMultiOperationResponse

ExecuteMultiOperationResponse

Returns​

void

FetchWorkerConfig()​

FetchWorkerConfig = void

FetchWorkerConfig returns the worker configuration for a specific worker.

Call Signature​

FetchWorkerConfig(request, callback): void

FetchWorkerConfig returns the worker configuration for a specific worker.

Parameters​
request​

IFetchWorkerConfigRequest

callback​

FetchWorkerConfigCallback

Returns​

void

Call Signature​

FetchWorkerConfig(request): Promise<FetchWorkerConfigResponse>

FetchWorkerConfig returns the worker configuration for a specific worker.

Parameters​
request​

IFetchWorkerConfigRequest

Returns​

Promise<FetchWorkerConfigResponse>

Properties​

name​

readonly name: "FetchWorkerConfig"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/FetchWorkerConfig"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "FetchWorkerConfigRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "FetchWorkerConfigResponse"

FetchWorkerConfigCallback​

FetchWorkerConfigCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

FetchWorkerConfigResponse

FetchWorkerConfigResponse

Returns​

void

GetClusterInfo()​

GetClusterInfo = void

GetClusterInfo returns information about temporal cluster

Call Signature​

GetClusterInfo(request, callback): void

GetClusterInfo returns information about temporal cluster

Parameters​
request​

IGetClusterInfoRequest

callback​

GetClusterInfoCallback

Returns​

void

Call Signature​

GetClusterInfo(request): Promise<GetClusterInfoResponse>

GetClusterInfo returns information about temporal cluster

Parameters​
request​

IGetClusterInfoRequest

Returns​

Promise<GetClusterInfoResponse>

Properties​

name​

readonly name: "GetClusterInfo"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetClusterInfo"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetClusterInfoRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetClusterInfoResponse"

GetClusterInfoCallback​

GetClusterInfoCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetClusterInfoResponse

GetClusterInfoResponse

Returns​

void

GetCurrentDeployment()​

GetCurrentDeployment = void

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

Call Signature​

GetCurrentDeployment(request, callback): void

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

Parameters​
request​

IGetCurrentDeploymentRequest

callback​

GetCurrentDeploymentCallback

Returns​

void

Call Signature​

GetCurrentDeployment(request): Promise<GetCurrentDeploymentResponse>

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

Parameters​
request​

IGetCurrentDeploymentRequest

Returns​

Promise<GetCurrentDeploymentResponse>

Properties​

name​

readonly name: "GetCurrentDeployment"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetCurrentDeployment"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetCurrentDeploymentRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetCurrentDeploymentResponse"

GetCurrentDeploymentCallback​

GetCurrentDeploymentCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetCurrentDeploymentResponse

GetCurrentDeploymentResponse

Returns​

void

GetDeploymentReachability()​

GetDeploymentReachability = void

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​

GetDeploymentReachability(request, callback): void

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.

Parameters​
request​

IGetDeploymentReachabilityRequest

callback​

GetDeploymentReachabilityCallback

Returns​

void

Call Signature​

GetDeploymentReachability(request): Promise<GetDeploymentReachabilityResponse>

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.

Parameters​
request​

IGetDeploymentReachabilityRequest

Returns​

Promise<GetDeploymentReachabilityResponse>

Properties​

name​

readonly name: "GetDeploymentReachability"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetDeploymentReachability"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetDeploymentReachabilityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetDeploymentReachabilityResponse"

GetDeploymentReachabilityCallback​

GetDeploymentReachabilityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetDeploymentReachabilityResponse

GetDeploymentReachabilityResponse

Returns​

void

GetSearchAttributes()​

GetSearchAttributes = void

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​

GetSearchAttributes(request, callback): void

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). --)

Parameters​
request​

IGetSearchAttributesRequest

callback​

GetSearchAttributesCallback

Returns​

void

Call Signature​

GetSearchAttributes(request): Promise<GetSearchAttributesResponse>

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). --)

Parameters​
request​

IGetSearchAttributesRequest

Returns​

Promise<GetSearchAttributesResponse>

Properties​

name​

readonly name: "GetSearchAttributes"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetSearchAttributes"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetSearchAttributesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetSearchAttributesResponse"

GetSearchAttributesCallback​

GetSearchAttributesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetSearchAttributesResponse

GetSearchAttributesResponse

Returns​

void

GetSystemInfo()​

GetSystemInfo = void

GetSystemInfo returns information about the system.

Call Signature​

GetSystemInfo(request, callback): void

GetSystemInfo returns information about the system.

Parameters​
request​

IGetSystemInfoRequest

callback​

GetSystemInfoCallback

Returns​

void

Call Signature​

GetSystemInfo(request): Promise<GetSystemInfoResponse>

GetSystemInfo returns information about the system.

Parameters​
request​

IGetSystemInfoRequest

Returns​

Promise<GetSystemInfoResponse>

Properties​

name​

readonly name: "GetSystemInfo"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetSystemInfo"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetSystemInfoRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetSystemInfoResponse"

GetSystemInfoCallback​

GetSystemInfoCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetSystemInfoResponse

GetSystemInfoResponse

Returns​

void

GetWorkerBuildIdCompatibility()​

GetWorkerBuildIdCompatibility = void

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​

GetWorkerBuildIdCompatibility(request, callback): void

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

Parameters​
request​

IGetWorkerBuildIdCompatibilityRequest

callback​

GetWorkerBuildIdCompatibilityCallback

Returns​

void

Call Signature​

GetWorkerBuildIdCompatibility(request): Promise<GetWorkerBuildIdCompatibilityResponse>

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

Parameters​
request​

IGetWorkerBuildIdCompatibilityRequest

Returns​

Promise<GetWorkerBuildIdCompatibilityResponse>

Properties​

name​

readonly name: "GetWorkerBuildIdCompatibility"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetWorkerBuildIdCompatibility"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetWorkerBuildIdCompatibilityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetWorkerBuildIdCompatibilityResponse"

GetWorkerBuildIdCompatibilityCallback​

GetWorkerBuildIdCompatibilityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetWorkerBuildIdCompatibilityResponse

GetWorkerBuildIdCompatibilityResponse

Returns​

void

GetWorkerTaskReachability()​

GetWorkerTaskReachability = void

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​

GetWorkerTaskReachability(request, callback): void

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.

Parameters​
request​

IGetWorkerTaskReachabilityRequest

callback​

GetWorkerTaskReachabilityCallback

Returns​

void

Call Signature​

GetWorkerTaskReachability(request): Promise<GetWorkerTaskReachabilityResponse>

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.

Parameters​
request​

IGetWorkerTaskReachabilityRequest

Returns​

Promise<GetWorkerTaskReachabilityResponse>

Properties​

name​

readonly name: "GetWorkerTaskReachability"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetWorkerTaskReachability"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetWorkerTaskReachabilityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetWorkerTaskReachabilityResponse"

GetWorkerTaskReachabilityCallback​

GetWorkerTaskReachabilityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetWorkerTaskReachabilityResponse

GetWorkerTaskReachabilityResponse

Returns​

void

GetWorkerVersioningRules()​

GetWorkerVersioningRules = void

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

Call Signature​

GetWorkerVersioningRules(request, callback): void

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

Parameters​
request​

IGetWorkerVersioningRulesRequest

callback​

GetWorkerVersioningRulesCallback

Returns​

void

Call Signature​

GetWorkerVersioningRules(request): Promise<GetWorkerVersioningRulesResponse>

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

Parameters​
request​

IGetWorkerVersioningRulesRequest

Returns​

Promise<GetWorkerVersioningRulesResponse>

Properties​

name​

readonly name: "GetWorkerVersioningRules"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetWorkerVersioningRules"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetWorkerVersioningRulesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetWorkerVersioningRulesResponse"

GetWorkerVersioningRulesCallback​

GetWorkerVersioningRulesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetWorkerVersioningRulesResponse

GetWorkerVersioningRulesResponse

Returns​

void

GetWorkflowExecutionHistory()​

GetWorkflowExecutionHistory = void

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

Call Signature​

GetWorkflowExecutionHistory(request, callback): void

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

Parameters​
request​

IGetWorkflowExecutionHistoryRequest

callback​

GetWorkflowExecutionHistoryCallback

Returns​

void

Call Signature​

GetWorkflowExecutionHistory(request): Promise<GetWorkflowExecutionHistoryResponse>

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

Parameters​
request​

IGetWorkflowExecutionHistoryRequest

Returns​

Promise<GetWorkflowExecutionHistoryResponse>

Properties​

name​

readonly name: "GetWorkflowExecutionHistory"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetWorkflowExecutionHistory"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetWorkflowExecutionHistoryRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetWorkflowExecutionHistoryResponse"

GetWorkflowExecutionHistoryCallback​

GetWorkflowExecutionHistoryCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetWorkflowExecutionHistoryResponse

GetWorkflowExecutionHistoryResponse

Returns​

void

GetWorkflowExecutionHistoryReverse()​

GetWorkflowExecutionHistoryReverse = void

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​

GetWorkflowExecutionHistoryReverse(request, callback): void

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.

Parameters​
request​

IGetWorkflowExecutionHistoryReverseRequest

callback​

GetWorkflowExecutionHistoryReverseCallback

Returns​

void

Call Signature​

GetWorkflowExecutionHistoryReverse(request): Promise<GetWorkflowExecutionHistoryReverseResponse>

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.

Parameters​
request​

IGetWorkflowExecutionHistoryReverseRequest

Returns​

Promise<GetWorkflowExecutionHistoryReverseResponse>

Properties​

name​

readonly name: "GetWorkflowExecutionHistoryReverse"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/GetWorkflowExecutionHistoryReverse"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetWorkflowExecutionHistoryReverseRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetWorkflowExecutionHistoryReverseResponse"

GetWorkflowExecutionHistoryReverseCallback​

GetWorkflowExecutionHistoryReverseCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetWorkflowExecutionHistoryReverseResponse

GetWorkflowExecutionHistoryReverseResponse

Returns​

void

ListActivityExecutions()​

ListActivityExecutions = void

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

Call Signature​

ListActivityExecutions(request, callback): void

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

Parameters​
request​

IListActivityExecutionsRequest

callback​

ListActivityExecutionsCallback

Returns​

void

Call Signature​

ListActivityExecutions(request): Promise<ListActivityExecutionsResponse>

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

Parameters​
request​

IListActivityExecutionsRequest

Returns​

Promise<ListActivityExecutionsResponse>

Properties​

name​

readonly name: "ListActivityExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListActivityExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListActivityExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListActivityExecutionsResponse"

ListActivityExecutionsCallback​

ListActivityExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListActivityExecutionsResponse

ListActivityExecutionsResponse

Returns​

void

ListArchivedWorkflowExecutions()​

ListArchivedWorkflowExecutions = void

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

Call Signature​

ListArchivedWorkflowExecutions(request, callback): void

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

Parameters​
request​

IListArchivedWorkflowExecutionsRequest

callback​

ListArchivedWorkflowExecutionsCallback

Returns​

void

Call Signature​

ListArchivedWorkflowExecutions(request): Promise<ListArchivedWorkflowExecutionsResponse>

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

Parameters​
request​

IListArchivedWorkflowExecutionsRequest

Returns​

Promise<ListArchivedWorkflowExecutionsResponse>

Properties​

name​

readonly name: "ListArchivedWorkflowExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListArchivedWorkflowExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListArchivedWorkflowExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListArchivedWorkflowExecutionsResponse"

ListArchivedWorkflowExecutionsCallback​

ListArchivedWorkflowExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListArchivedWorkflowExecutionsResponse

ListArchivedWorkflowExecutionsResponse

Returns​

void

ListBatchOperations()​

ListBatchOperations = void

ListBatchOperations returns a list of batch operations

Call Signature​

ListBatchOperations(request, callback): void

ListBatchOperations returns a list of batch operations

Parameters​
request​

IListBatchOperationsRequest

callback​

ListBatchOperationsCallback

Returns​

void

Call Signature​

ListBatchOperations(request): Promise<ListBatchOperationsResponse>

ListBatchOperations returns a list of batch operations

Parameters​
request​

IListBatchOperationsRequest

Returns​

Promise<ListBatchOperationsResponse>

Properties​

name​

readonly name: "ListBatchOperations"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListBatchOperations"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListBatchOperationsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListBatchOperationsResponse"

ListBatchOperationsCallback​

ListBatchOperationsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListBatchOperationsResponse

ListBatchOperationsResponse

Returns​

void

ListClosedWorkflowExecutions()​

ListClosedWorkflowExecutions = void

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​

ListClosedWorkflowExecutions(request, callback): void

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. --)

Parameters​
request​

IListClosedWorkflowExecutionsRequest

callback​

ListClosedWorkflowExecutionsCallback

Returns​

void

Call Signature​

ListClosedWorkflowExecutions(request): Promise<ListClosedWorkflowExecutionsResponse>

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. --)

Parameters​
request​

IListClosedWorkflowExecutionsRequest

Returns​

Promise<ListClosedWorkflowExecutionsResponse>

Properties​

name​

readonly name: "ListClosedWorkflowExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListClosedWorkflowExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListClosedWorkflowExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListClosedWorkflowExecutionsResponse"

ListClosedWorkflowExecutionsCallback​

ListClosedWorkflowExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListClosedWorkflowExecutionsResponse

ListClosedWorkflowExecutionsResponse

Returns​

void

ListDeployments()​

ListDeployments = void

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

Call Signature​

ListDeployments(request, callback): void

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

Parameters​
request​

IListDeploymentsRequest

callback​

ListDeploymentsCallback

Returns​

void

Call Signature​

ListDeployments(request): Promise<ListDeploymentsResponse>

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

Parameters​
request​

IListDeploymentsRequest

Returns​

Promise<ListDeploymentsResponse>

Properties​

name​

readonly name: "ListDeployments"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListDeployments"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListDeploymentsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListDeploymentsResponse"

ListDeploymentsCallback​

ListDeploymentsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListDeploymentsResponse

ListDeploymentsResponse

Returns​

void

ListNamespaces()​

ListNamespaces = void

ListNamespaces returns the information and configuration for all namespaces.

Call Signature​

ListNamespaces(request, callback): void

ListNamespaces returns the information and configuration for all namespaces.

Parameters​
request​

IListNamespacesRequest

callback​

ListNamespacesCallback

Returns​

void

Call Signature​

ListNamespaces(request): Promise<ListNamespacesResponse>

ListNamespaces returns the information and configuration for all namespaces.

Parameters​
request​

IListNamespacesRequest

Returns​

Promise<ListNamespacesResponse>

Properties​

name​

readonly name: "ListNamespaces"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListNamespaces"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListNamespacesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListNamespacesResponse"

ListNamespacesCallback​

ListNamespacesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListNamespacesResponse

ListNamespacesResponse

Returns​

void

ListNexusOperationExecutions()​

ListNexusOperationExecutions = void

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

Call Signature​

ListNexusOperationExecutions(request, callback): void

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

Parameters​
request​

IListNexusOperationExecutionsRequest

callback​

ListNexusOperationExecutionsCallback

Returns​

void

Call Signature​

ListNexusOperationExecutions(request): Promise<ListNexusOperationExecutionsResponse>

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

Parameters​
request​

IListNexusOperationExecutionsRequest

Returns​

Promise<ListNexusOperationExecutionsResponse>

Properties​

name​

readonly name: "ListNexusOperationExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListNexusOperationExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListNexusOperationExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListNexusOperationExecutionsResponse"

ListNexusOperationExecutionsCallback​

ListNexusOperationExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListNexusOperationExecutionsResponse

ListNexusOperationExecutionsResponse

Returns​

void

ListOpenWorkflowExecutions()​

ListOpenWorkflowExecutions = void

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​

ListOpenWorkflowExecutions(request, callback): void

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. --)

Parameters​
request​

IListOpenWorkflowExecutionsRequest

callback​

ListOpenWorkflowExecutionsCallback

Returns​

void

Call Signature​

ListOpenWorkflowExecutions(request): Promise<ListOpenWorkflowExecutionsResponse>

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. --)

Parameters​
request​

IListOpenWorkflowExecutionsRequest

Returns​

Promise<ListOpenWorkflowExecutionsResponse>

Properties​

name​

readonly name: "ListOpenWorkflowExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListOpenWorkflowExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListOpenWorkflowExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListOpenWorkflowExecutionsResponse"

ListOpenWorkflowExecutionsCallback​

ListOpenWorkflowExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListOpenWorkflowExecutionsResponse

ListOpenWorkflowExecutionsResponse

Returns​

void

ListScheduleMatchingTimes()​

ListScheduleMatchingTimes = void

Lists matching times within a range.

Call Signature​

ListScheduleMatchingTimes(request, callback): void

Lists matching times within a range.

Parameters​
request​

IListScheduleMatchingTimesRequest

callback​

ListScheduleMatchingTimesCallback

Returns​

void

Call Signature​

ListScheduleMatchingTimes(request): Promise<ListScheduleMatchingTimesResponse>

Lists matching times within a range.

Parameters​
request​

IListScheduleMatchingTimesRequest

Returns​

Promise<ListScheduleMatchingTimesResponse>

Properties​

name​

readonly name: "ListScheduleMatchingTimes"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListScheduleMatchingTimes"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListScheduleMatchingTimesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListScheduleMatchingTimesResponse"

ListScheduleMatchingTimesCallback​

ListScheduleMatchingTimesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListScheduleMatchingTimesResponse

ListScheduleMatchingTimesResponse

Returns​

void

ListSchedules()​

ListSchedules = void

List all schedules in a namespace.

Call Signature​

ListSchedules(request, callback): void

List all schedules in a namespace.

Parameters​
request​

IListSchedulesRequest

callback​

ListSchedulesCallback

Returns​

void

Call Signature​

ListSchedules(request): Promise<ListSchedulesResponse>

List all schedules in a namespace.

Parameters​
request​

IListSchedulesRequest

Returns​

Promise<ListSchedulesResponse>

Properties​

name​

readonly name: "ListSchedules"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListSchedules"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListSchedulesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListSchedulesResponse"

ListSchedulesCallback​

ListSchedulesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListSchedulesResponse

ListSchedulesResponse

Returns​

void

ListTaskQueuePartitions()​

ListTaskQueuePartitions = void

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

Call Signature​

ListTaskQueuePartitions(request, callback): void

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

Parameters​
request​

IListTaskQueuePartitionsRequest

callback​

ListTaskQueuePartitionsCallback

Returns​

void

Call Signature​

ListTaskQueuePartitions(request): Promise<ListTaskQueuePartitionsResponse>

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

Parameters​
request​

IListTaskQueuePartitionsRequest

Returns​

Promise<ListTaskQueuePartitionsResponse>

Properties​

name​

readonly name: "ListTaskQueuePartitions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListTaskQueuePartitions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListTaskQueuePartitionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListTaskQueuePartitionsResponse"

ListTaskQueuePartitionsCallback​

ListTaskQueuePartitionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListTaskQueuePartitionsResponse

ListTaskQueuePartitionsResponse

Returns​

void

ListWorkerDeployments()​

ListWorkerDeployments = void

Lists all Worker Deployments that are tracked in the Namespace.

Call Signature​

ListWorkerDeployments(request, callback): void

Lists all Worker Deployments that are tracked in the Namespace.

Parameters​
request​

IListWorkerDeploymentsRequest

callback​

ListWorkerDeploymentsCallback

Returns​

void

Call Signature​

ListWorkerDeployments(request): Promise<ListWorkerDeploymentsResponse>

Lists all Worker Deployments that are tracked in the Namespace.

Parameters​
request​

IListWorkerDeploymentsRequest

Returns​

Promise<ListWorkerDeploymentsResponse>

Properties​

name​

readonly name: "ListWorkerDeployments"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListWorkerDeployments"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListWorkerDeploymentsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListWorkerDeploymentsResponse"

ListWorkerDeploymentsCallback​

ListWorkerDeploymentsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListWorkerDeploymentsResponse

ListWorkerDeploymentsResponse

Returns​

void

ListWorkers()​

ListWorkers = void

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

Call Signature​

ListWorkers(request, callback): void

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

Parameters​
request​

IListWorkersRequest

callback​

ListWorkersCallback

Returns​

void

Call Signature​

ListWorkers(request): Promise<ListWorkersResponse>

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

Parameters​
request​

IListWorkersRequest

Returns​

Promise<ListWorkersResponse>

Properties​

name​

readonly name: "ListWorkers"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListWorkers"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListWorkersRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListWorkersResponse"

ListWorkersCallback​

ListWorkersCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListWorkersResponse

ListWorkersResponse

Returns​

void

ListWorkflowExecutions()​

ListWorkflowExecutions = void

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

Call Signature​

ListWorkflowExecutions(request, callback): void

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

Parameters​
request​

IListWorkflowExecutionsRequest

callback​

ListWorkflowExecutionsCallback

Returns​

void

Call Signature​

ListWorkflowExecutions(request): Promise<ListWorkflowExecutionsResponse>

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

Parameters​
request​

IListWorkflowExecutionsRequest

Returns​

Promise<ListWorkflowExecutionsResponse>

Properties​

name​

readonly name: "ListWorkflowExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListWorkflowExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListWorkflowExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListWorkflowExecutionsResponse"

ListWorkflowExecutionsCallback​

ListWorkflowExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListWorkflowExecutionsResponse

ListWorkflowExecutionsResponse

Returns​

void

ListWorkflowRules()​

ListWorkflowRules = void

Return all namespace workflow rules

Call Signature​

ListWorkflowRules(request, callback): void

Return all namespace workflow rules

Parameters​
request​

IListWorkflowRulesRequest

callback​

ListWorkflowRulesCallback

Returns​

void

Call Signature​

ListWorkflowRules(request): Promise<ListWorkflowRulesResponse>

Return all namespace workflow rules

Parameters​
request​

IListWorkflowRulesRequest

Returns​

Promise<ListWorkflowRulesResponse>

Properties​

name​

readonly name: "ListWorkflowRules"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ListWorkflowRules"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListWorkflowRulesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListWorkflowRulesResponse"

ListWorkflowRulesCallback​

ListWorkflowRulesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListWorkflowRulesResponse

ListWorkflowRulesResponse

Returns​

void

PatchSchedule()​

PatchSchedule = void

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

Call Signature​

PatchSchedule(request, callback): void

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

Parameters​
request​

IPatchScheduleRequest

callback​

PatchScheduleCallback

Returns​

void

Call Signature​

PatchSchedule(request): Promise<PatchScheduleResponse>

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

Parameters​
request​

IPatchScheduleRequest

Returns​

Promise<PatchScheduleResponse>

Properties​

name​

readonly name: "PatchSchedule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PatchSchedule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PatchScheduleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PatchScheduleResponse"

PatchScheduleCallback​

PatchScheduleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PatchScheduleResponse

PatchScheduleResponse

Returns​

void

PauseActivity()​

PauseActivity = void

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​

PauseActivity(request, callback): void

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.

Parameters​
request​

IPauseActivityRequest

callback​

PauseActivityCallback

Returns​

void

Call Signature​

PauseActivity(request): Promise<PauseActivityResponse>

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.

Parameters​
request​

IPauseActivityRequest

Returns​

Promise<PauseActivityResponse>

Properties​

name​

readonly name: "PauseActivity"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PauseActivity"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PauseActivityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PauseActivityResponse"

PauseActivityCallback​

PauseActivityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PauseActivityResponse

PauseActivityResponse

Returns​

void

PauseActivityExecution()​

PauseActivityExecution = void

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​

PauseActivityExecution(request, callback): void

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

Parameters​
request​

IPauseActivityExecutionRequest

callback​

PauseActivityExecutionCallback

Returns​

void

Call Signature​

PauseActivityExecution(request): Promise<PauseActivityExecutionResponse>

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

Parameters​
request​

IPauseActivityExecutionRequest

Returns​

Promise<PauseActivityExecutionResponse>

Properties​

name​

readonly name: "PauseActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PauseActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PauseActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PauseActivityExecutionResponse"

PauseActivityExecutionCallback​

PauseActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PauseActivityExecutionResponse

PauseActivityExecutionResponse

Returns​

void

PauseWorkflowExecution()​

PauseWorkflowExecution = void

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​

PauseWorkflowExecution(request, callback): void

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.
Parameters​
request​

IPauseWorkflowExecutionRequest

callback​

PauseWorkflowExecutionCallback

Returns​

void

Call Signature​

PauseWorkflowExecution(request): Promise<PauseWorkflowExecutionResponse>

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.
Parameters​
request​

IPauseWorkflowExecutionRequest

Returns​

Promise<PauseWorkflowExecutionResponse>

Properties​

name​

readonly name: "PauseWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PauseWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PauseWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PauseWorkflowExecutionResponse"

PauseWorkflowExecutionCallback​

PauseWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PauseWorkflowExecutionResponse

PauseWorkflowExecutionResponse

Returns​

void

PollActivityExecution()​

PollActivityExecution = void

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

Call Signature​

PollActivityExecution(request, callback): void

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

Parameters​
request​

IPollActivityExecutionRequest

callback​

PollActivityExecutionCallback

Returns​

void

Call Signature​

PollActivityExecution(request): Promise<PollActivityExecutionResponse>

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

Parameters​
request​

IPollActivityExecutionRequest

Returns​

Promise<PollActivityExecutionResponse>

Properties​

name​

readonly name: "PollActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollActivityExecutionResponse"

PollActivityExecutionCallback​

PollActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollActivityExecutionResponse

PollActivityExecutionResponse

Returns​

void

PollActivityTaskQueue()​

PollActivityTaskQueue = void

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​

PollActivityTaskQueue(request, callback): void

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. --)

Parameters​
request​

IPollActivityTaskQueueRequest

callback​

PollActivityTaskQueueCallback

Returns​

void

Call Signature​

PollActivityTaskQueue(request): Promise<PollActivityTaskQueueResponse>

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. --)

Parameters​
request​

IPollActivityTaskQueueRequest

Returns​

Promise<PollActivityTaskQueueResponse>

Properties​

name​

readonly name: "PollActivityTaskQueue"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollActivityTaskQueue"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollActivityTaskQueueRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollActivityTaskQueueResponse"

PollActivityTaskQueueCallback​

PollActivityTaskQueueCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollActivityTaskQueueResponse

PollActivityTaskQueueResponse

Returns​

void

PollNexusOperationExecution()​

PollNexusOperationExecution = void

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

Call Signature​

PollNexusOperationExecution(request, callback): void

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

Parameters​
request​

IPollNexusOperationExecutionRequest

callback​

PollNexusOperationExecutionCallback

Returns​

void

Call Signature​

PollNexusOperationExecution(request): Promise<PollNexusOperationExecutionResponse>

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

Parameters​
request​

IPollNexusOperationExecutionRequest

Returns​

Promise<PollNexusOperationExecutionResponse>

Properties​

name​

readonly name: "PollNexusOperationExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollNexusOperationExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollNexusOperationExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollNexusOperationExecutionResponse"

PollNexusOperationExecutionCallback​

PollNexusOperationExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollNexusOperationExecutionResponse

PollNexusOperationExecutionResponse

Returns​

void

PollNexusTaskQueue()​

PollNexusTaskQueue = void

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​

PollNexusTaskQueue(request, callback): void

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. --)

Parameters​
request​

IPollNexusTaskQueueRequest

callback​

PollNexusTaskQueueCallback

Returns​

void

Call Signature​

PollNexusTaskQueue(request): Promise<PollNexusTaskQueueResponse>

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. --)

Parameters​
request​

IPollNexusTaskQueueRequest

Returns​

Promise<PollNexusTaskQueueResponse>

Properties​

name​

readonly name: "PollNexusTaskQueue"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollNexusTaskQueue"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollNexusTaskQueueRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollNexusTaskQueueResponse"

PollNexusTaskQueueCallback​

PollNexusTaskQueueCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse

Returns​

void

PollWorkflowExecutionTimeSkipping()​

PollWorkflowExecutionTimeSkipping = void

Calls PollWorkflowExecutionTimeSkipping.

Call Signature​

PollWorkflowExecutionTimeSkipping(request, callback): void

Calls PollWorkflowExecutionTimeSkipping.

Parameters​
request​

IPollWorkflowExecutionTimeSkippingRequest

callback​

PollWorkflowExecutionTimeSkippingCallback

Returns​

void

Call Signature​

PollWorkflowExecutionTimeSkipping(request): Promise<PollWorkflowExecutionTimeSkippingResponse>

Calls PollWorkflowExecutionTimeSkipping.

Parameters​
request​

IPollWorkflowExecutionTimeSkippingRequest

Returns​

Promise<PollWorkflowExecutionTimeSkippingResponse>

Properties​

name​

readonly name: "PollWorkflowExecutionTimeSkipping"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollWorkflowExecutionTimeSkipping"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollWorkflowExecutionTimeSkippingRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollWorkflowExecutionTimeSkippingResponse"

PollWorkflowExecutionTimeSkippingCallback​

PollWorkflowExecutionTimeSkippingCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollWorkflowExecutionTimeSkippingResponse

PollWorkflowExecutionTimeSkippingResponse

Returns​

void

PollWorkflowExecutionUpdate()​

PollWorkflowExecutionUpdate = void

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​

PollWorkflowExecutionUpdate(request, callback): void

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. --)

Parameters​
request​

IPollWorkflowExecutionUpdateRequest

callback​

PollWorkflowExecutionUpdateCallback

Returns​

void

Call Signature​

PollWorkflowExecutionUpdate(request): Promise<PollWorkflowExecutionUpdateResponse>

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. --)

Parameters​
request​

IPollWorkflowExecutionUpdateRequest

Returns​

Promise<PollWorkflowExecutionUpdateResponse>

Properties​

name​

readonly name: "PollWorkflowExecutionUpdate"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollWorkflowExecutionUpdate"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollWorkflowExecutionUpdateRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollWorkflowExecutionUpdateResponse"

PollWorkflowExecutionUpdateCallback​

PollWorkflowExecutionUpdateCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollWorkflowExecutionUpdateResponse

PollWorkflowExecutionUpdateResponse

Returns​

void

PollWorkflowTaskQueue()​

PollWorkflowTaskQueue = void

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​

PollWorkflowTaskQueue(request, callback): void

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. --)

Parameters​
request​

IPollWorkflowTaskQueueRequest

callback​

PollWorkflowTaskQueueCallback

Returns​

void

Call Signature​

PollWorkflowTaskQueue(request): Promise<PollWorkflowTaskQueueResponse>

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. --)

Parameters​
request​

IPollWorkflowTaskQueueRequest

Returns​

Promise<PollWorkflowTaskQueueResponse>

Properties​

name​

readonly name: "PollWorkflowTaskQueue"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/PollWorkflowTaskQueue"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "PollWorkflowTaskQueueRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "PollWorkflowTaskQueueResponse"

PollWorkflowTaskQueueCallback​

PollWorkflowTaskQueueCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

PollWorkflowTaskQueueResponse

PollWorkflowTaskQueueResponse

Returns​

void

QueryWorkflow()​

QueryWorkflow = void

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

Call Signature​

QueryWorkflow(request, callback): void

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

Parameters​
request​

IQueryWorkflowRequest

callback​

QueryWorkflowCallback

Returns​

void

Call Signature​

QueryWorkflow(request): Promise<QueryWorkflowResponse>

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

Parameters​
request​

IQueryWorkflowRequest

Returns​

Promise<QueryWorkflowResponse>

Properties​

name​

readonly name: "QueryWorkflow"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/QueryWorkflow"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "QueryWorkflowRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "QueryWorkflowResponse"

QueryWorkflowCallback​

QueryWorkflowCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

QueryWorkflowResponse

QueryWorkflowResponse

Returns​

void

RecordActivityTaskHeartbeat()​

RecordActivityTaskHeartbeat = void

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​

RecordActivityTaskHeartbeat(request, callback): void

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.

Parameters​
request​

IRecordActivityTaskHeartbeatRequest

callback​

RecordActivityTaskHeartbeatCallback

Returns​

void

Call Signature​

RecordActivityTaskHeartbeat(request): Promise<RecordActivityTaskHeartbeatResponse>

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.

Parameters​
request​

IRecordActivityTaskHeartbeatRequest

Returns​

Promise<RecordActivityTaskHeartbeatResponse>

Properties​

name​

readonly name: "RecordActivityTaskHeartbeat"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RecordActivityTaskHeartbeat"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RecordActivityTaskHeartbeatRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RecordActivityTaskHeartbeatResponse"

RecordActivityTaskHeartbeatById()​

RecordActivityTaskHeartbeatById = void

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​

RecordActivityTaskHeartbeatById(request, callback): void

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. --)

Parameters​
request​

IRecordActivityTaskHeartbeatByIdRequest

callback​

RecordActivityTaskHeartbeatByIdCallback

Returns​

void

Call Signature​

RecordActivityTaskHeartbeatById(request): Promise<RecordActivityTaskHeartbeatByIdResponse>

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. --)

Parameters​
request​

IRecordActivityTaskHeartbeatByIdRequest

Returns​

Promise<RecordActivityTaskHeartbeatByIdResponse>

Properties​

name​

readonly name: "RecordActivityTaskHeartbeatById"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RecordActivityTaskHeartbeatById"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RecordActivityTaskHeartbeatByIdRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RecordActivityTaskHeartbeatByIdResponse"

RecordActivityTaskHeartbeatByIdCallback​

RecordActivityTaskHeartbeatByIdCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RecordActivityTaskHeartbeatByIdResponse

RecordActivityTaskHeartbeatByIdResponse

Returns​

void

RecordActivityTaskHeartbeatCallback​

RecordActivityTaskHeartbeatCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RecordActivityTaskHeartbeatResponse

RecordActivityTaskHeartbeatResponse

Returns​

void

RecordWorkerHeartbeat()​

RecordWorkerHeartbeat = void

WorkerHeartbeat receive heartbeat request from the worker.

Call Signature​

RecordWorkerHeartbeat(request, callback): void

WorkerHeartbeat receive heartbeat request from the worker.

Parameters​
request​

IRecordWorkerHeartbeatRequest

callback​

RecordWorkerHeartbeatCallback

Returns​

void

Call Signature​

RecordWorkerHeartbeat(request): Promise<RecordWorkerHeartbeatResponse>

WorkerHeartbeat receive heartbeat request from the worker.

Parameters​
request​

IRecordWorkerHeartbeatRequest

Returns​

Promise<RecordWorkerHeartbeatResponse>

Properties​

name​

readonly name: "RecordWorkerHeartbeat"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RecordWorkerHeartbeat"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RecordWorkerHeartbeatRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RecordWorkerHeartbeatResponse"

RecordWorkerHeartbeatCallback​

RecordWorkerHeartbeatCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RecordWorkerHeartbeatResponse

RecordWorkerHeartbeatResponse

Returns​

void

RegisterNamespace()​

RegisterNamespace = void

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​

RegisterNamespace(request, callback): void

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.

Parameters​
request​

IRegisterNamespaceRequest

callback​

RegisterNamespaceCallback

Returns​

void

Call Signature​

RegisterNamespace(request): Promise<RegisterNamespaceResponse>

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.

Parameters​
request​

IRegisterNamespaceRequest

Returns​

Promise<RegisterNamespaceResponse>

Properties​

name​

readonly name: "RegisterNamespace"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RegisterNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RegisterNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RegisterNamespaceResponse"

RegisterNamespaceCallback​

RegisterNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RegisterNamespaceResponse

RegisterNamespaceResponse

Returns​

void

RequestCancelActivityExecution()​

RequestCancelActivityExecution = void

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​

RequestCancelActivityExecution(request, callback): void

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).

Parameters​
request​

IRequestCancelActivityExecutionRequest

callback​

RequestCancelActivityExecutionCallback

Returns​

void

Call Signature​

RequestCancelActivityExecution(request): Promise<RequestCancelActivityExecutionResponse>

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).

Parameters​
request​

IRequestCancelActivityExecutionRequest

Returns​

Promise<RequestCancelActivityExecutionResponse>

Properties​

name​

readonly name: "RequestCancelActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RequestCancelActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RequestCancelActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RequestCancelActivityExecutionResponse"

RequestCancelActivityExecutionCallback​

RequestCancelActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RequestCancelActivityExecutionResponse

RequestCancelActivityExecutionResponse

Returns​

void

RequestCancelNexusOperationExecution()​

RequestCancelNexusOperationExecution = void

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​

RequestCancelNexusOperationExecution(request, callback): void

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.

Parameters​
request​

IRequestCancelNexusOperationExecutionRequest

callback​

RequestCancelNexusOperationExecutionCallback

Returns​

void

Call Signature​

RequestCancelNexusOperationExecution(request): Promise<RequestCancelNexusOperationExecutionResponse>

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.

Parameters​
request​

IRequestCancelNexusOperationExecutionRequest

Returns​

Promise<RequestCancelNexusOperationExecutionResponse>

Properties​

name​

readonly name: "RequestCancelNexusOperationExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RequestCancelNexusOperationExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RequestCancelNexusOperationExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RequestCancelNexusOperationExecutionResponse"

RequestCancelNexusOperationExecutionCallback​

RequestCancelNexusOperationExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RequestCancelNexusOperationExecutionResponse

RequestCancelNexusOperationExecutionResponse

Returns​

void

RequestCancelWorkflowExecution()​

RequestCancelWorkflowExecution = void

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​

RequestCancelWorkflowExecution(request, callback): void

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.

Parameters​
request​

IRequestCancelWorkflowExecutionRequest

callback​

RequestCancelWorkflowExecutionCallback

Returns​

void

Call Signature​

RequestCancelWorkflowExecution(request): Promise<RequestCancelWorkflowExecutionResponse>

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.

Parameters​
request​

IRequestCancelWorkflowExecutionRequest

Returns​

Promise<RequestCancelWorkflowExecutionResponse>

Properties​

name​

readonly name: "RequestCancelWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RequestCancelWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RequestCancelWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RequestCancelWorkflowExecutionResponse"

RequestCancelWorkflowExecutionCallback​

RequestCancelWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RequestCancelWorkflowExecutionResponse

RequestCancelWorkflowExecutionResponse

Returns​

void

ResetActivity()​

ResetActivity = void

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​

ResetActivity(request, callback): void

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.

Parameters​
request​

IResetActivityRequest

callback​

ResetActivityCallback

Returns​

void

Call Signature​

ResetActivity(request): Promise<ResetActivityResponse>

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.

Parameters​
request​

IResetActivityRequest

Returns​

Promise<ResetActivityResponse>

Properties​

name​

readonly name: "ResetActivity"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ResetActivity"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ResetActivityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ResetActivityResponse"

ResetActivityCallback​

ResetActivityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ResetActivityResponse

ResetActivityResponse

Returns​

void

ResetActivityExecution()​

ResetActivityExecution = void

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​

ResetActivityExecution(request, callback): void

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.

Parameters​
request​

IResetActivityExecutionRequest

callback​

ResetActivityExecutionCallback

Returns​

void

Call Signature​

ResetActivityExecution(request): Promise<ResetActivityExecutionResponse>

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.

Parameters​
request​

IResetActivityExecutionRequest

Returns​

Promise<ResetActivityExecutionResponse>

Properties​

name​

readonly name: "ResetActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ResetActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ResetActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ResetActivityExecutionResponse"

ResetActivityExecutionCallback​

ResetActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ResetActivityExecutionResponse

ResetActivityExecutionResponse

Returns​

void

ResetStickyTaskQueue()​

ResetStickyTaskQueue = void

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​

ResetStickyTaskQueue(request, callback): void

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. --)

Parameters​
request​

IResetStickyTaskQueueRequest

callback​

ResetStickyTaskQueueCallback

Returns​

void

Call Signature​

ResetStickyTaskQueue(request): Promise<ResetStickyTaskQueueResponse>

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. --)

Parameters​
request​

IResetStickyTaskQueueRequest

Returns​

Promise<ResetStickyTaskQueueResponse>

Properties​

name​

readonly name: "ResetStickyTaskQueue"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ResetStickyTaskQueue"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ResetStickyTaskQueueRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ResetStickyTaskQueueResponse"

ResetStickyTaskQueueCallback​

ResetStickyTaskQueueCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ResetStickyTaskQueueResponse

ResetStickyTaskQueueResponse

Returns​

void

ResetWorkflowExecution()​

ResetWorkflowExecution = void

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​

ResetWorkflowExecution(request, callback): void

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.

Parameters​
request​

IResetWorkflowExecutionRequest

callback​

ResetWorkflowExecutionCallback

Returns​

void

Call Signature​

ResetWorkflowExecution(request): Promise<ResetWorkflowExecutionResponse>

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.

Parameters​
request​

IResetWorkflowExecutionRequest

Returns​

Promise<ResetWorkflowExecutionResponse>

Properties​

name​

readonly name: "ResetWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ResetWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ResetWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ResetWorkflowExecutionResponse"

ResetWorkflowExecutionCallback​

ResetWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ResetWorkflowExecutionResponse

ResetWorkflowExecutionResponse

Returns​

void

RespondActivityTaskCanceled()​

RespondActivityTaskCanceled = void

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​

RespondActivityTaskCanceled(request, callback): void

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.

Parameters​
request​

IRespondActivityTaskCanceledRequest

callback​

RespondActivityTaskCanceledCallback

Returns​

void

Call Signature​

RespondActivityTaskCanceled(request): Promise<RespondActivityTaskCanceledResponse>

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.

Parameters​
request​

IRespondActivityTaskCanceledRequest

Returns​

Promise<RespondActivityTaskCanceledResponse>

Properties​

name​

readonly name: "RespondActivityTaskCanceled"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCanceled"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondActivityTaskCanceledRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondActivityTaskCanceledResponse"

RespondActivityTaskCanceledById()​

RespondActivityTaskCanceledById = void

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​

RespondActivityTaskCanceledById(request, callback): void

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. --)

Parameters​
request​

IRespondActivityTaskCanceledByIdRequest

callback​

RespondActivityTaskCanceledByIdCallback

Returns​

void

Call Signature​

RespondActivityTaskCanceledById(request): Promise<RespondActivityTaskCanceledByIdResponse>

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. --)

Parameters​
request​

IRespondActivityTaskCanceledByIdRequest

Returns​

Promise<RespondActivityTaskCanceledByIdResponse>

Properties​

name​

readonly name: "RespondActivityTaskCanceledById"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCanceledById"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondActivityTaskCanceledByIdRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondActivityTaskCanceledByIdResponse"

RespondActivityTaskCanceledByIdCallback​

RespondActivityTaskCanceledByIdCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondActivityTaskCanceledByIdResponse

RespondActivityTaskCanceledByIdResponse

Returns​

void

RespondActivityTaskCanceledCallback​

RespondActivityTaskCanceledCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondActivityTaskCanceledResponse

RespondActivityTaskCanceledResponse

Returns​

void

RespondActivityTaskCompleted()​

RespondActivityTaskCompleted = void

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​

RespondActivityTaskCompleted(request, callback): void

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.

Parameters​
request​

IRespondActivityTaskCompletedRequest

callback​

RespondActivityTaskCompletedCallback

Returns​

void

Call Signature​

RespondActivityTaskCompleted(request): Promise<RespondActivityTaskCompletedResponse>

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.

Parameters​
request​

IRespondActivityTaskCompletedRequest

Returns​

Promise<RespondActivityTaskCompletedResponse>

Properties​

name​

readonly name: "RespondActivityTaskCompleted"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCompleted"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondActivityTaskCompletedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondActivityTaskCompletedResponse"

RespondActivityTaskCompletedById()​

RespondActivityTaskCompletedById = void

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​

RespondActivityTaskCompletedById(request, callback): void

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. --)

Parameters​
request​

IRespondActivityTaskCompletedByIdRequest

callback​

RespondActivityTaskCompletedByIdCallback

Returns​

void

Call Signature​

RespondActivityTaskCompletedById(request): Promise<RespondActivityTaskCompletedByIdResponse>

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. --)

Parameters​
request​

IRespondActivityTaskCompletedByIdRequest

Returns​

Promise<RespondActivityTaskCompletedByIdResponse>

Properties​

name​

readonly name: "RespondActivityTaskCompletedById"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskCompletedById"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondActivityTaskCompletedByIdRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondActivityTaskCompletedByIdResponse"

RespondActivityTaskCompletedByIdCallback​

RespondActivityTaskCompletedByIdCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondActivityTaskCompletedByIdResponse

RespondActivityTaskCompletedByIdResponse

Returns​

void

RespondActivityTaskCompletedCallback​

RespondActivityTaskCompletedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondActivityTaskCompletedResponse

RespondActivityTaskCompletedResponse

Returns​

void

RespondActivityTaskFailed()​

RespondActivityTaskFailed = void

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​

RespondActivityTaskFailed(request, callback): void

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.

Parameters​
request​

IRespondActivityTaskFailedRequest

callback​

RespondActivityTaskFailedCallback

Returns​

void

Call Signature​

RespondActivityTaskFailed(request): Promise<RespondActivityTaskFailedResponse>

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.

Parameters​
request​

IRespondActivityTaskFailedRequest

Returns​

Promise<RespondActivityTaskFailedResponse>

Properties​

name​

readonly name: "RespondActivityTaskFailed"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskFailed"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondActivityTaskFailedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondActivityTaskFailedResponse"

RespondActivityTaskFailedById()​

RespondActivityTaskFailedById = void

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​

RespondActivityTaskFailedById(request, callback): void

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. --)

Parameters​
request​

IRespondActivityTaskFailedByIdRequest

callback​

RespondActivityTaskFailedByIdCallback

Returns​

void

Call Signature​

RespondActivityTaskFailedById(request): Promise<RespondActivityTaskFailedByIdResponse>

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. --)

Parameters​
request​

IRespondActivityTaskFailedByIdRequest

Returns​

Promise<RespondActivityTaskFailedByIdResponse>

Properties​

name​

readonly name: "RespondActivityTaskFailedById"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondActivityTaskFailedById"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondActivityTaskFailedByIdRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondActivityTaskFailedByIdResponse"

RespondActivityTaskFailedByIdCallback​

RespondActivityTaskFailedByIdCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondActivityTaskFailedByIdResponse

RespondActivityTaskFailedByIdResponse

Returns​

void

RespondActivityTaskFailedCallback​

RespondActivityTaskFailedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondActivityTaskFailedResponse

RespondActivityTaskFailedResponse

Returns​

void

RespondNexusTaskCompleted()​

RespondNexusTaskCompleted = void

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​

RespondNexusTaskCompleted(request, callback): void

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. --)

Parameters​
request​

IRespondNexusTaskCompletedRequest

callback​

RespondNexusTaskCompletedCallback

Returns​

void

Call Signature​

RespondNexusTaskCompleted(request): Promise<RespondNexusTaskCompletedResponse>

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. --)

Parameters​
request​

IRespondNexusTaskCompletedRequest

Returns​

Promise<RespondNexusTaskCompletedResponse>

Properties​

name​

readonly name: "RespondNexusTaskCompleted"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondNexusTaskCompleted"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondNexusTaskCompletedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondNexusTaskCompletedResponse"

RespondNexusTaskCompletedCallback​

RespondNexusTaskCompletedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondNexusTaskCompletedResponse

RespondNexusTaskCompletedResponse

Returns​

void

RespondNexusTaskFailed()​

RespondNexusTaskFailed = void

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​

RespondNexusTaskFailed(request, callback): void

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. --)

Parameters​
request​

IRespondNexusTaskFailedRequest

callback​

RespondNexusTaskFailedCallback

Returns​

void

Call Signature​

RespondNexusTaskFailed(request): Promise<RespondNexusTaskFailedResponse>

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. --)

Parameters​
request​

IRespondNexusTaskFailedRequest

Returns​

Promise<RespondNexusTaskFailedResponse>

Properties​

name​

readonly name: "RespondNexusTaskFailed"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondNexusTaskFailed"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondNexusTaskFailedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondNexusTaskFailedResponse"

RespondNexusTaskFailedCallback​

RespondNexusTaskFailedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondNexusTaskFailedResponse

RespondNexusTaskFailedResponse

Returns​

void

RespondQueryTaskCompleted()​

RespondQueryTaskCompleted = void

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​

RespondQueryTaskCompleted(request, callback): void

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. --)

Parameters​
request​

IRespondQueryTaskCompletedRequest

callback​

RespondQueryTaskCompletedCallback

Returns​

void

Call Signature​

RespondQueryTaskCompleted(request): Promise<RespondQueryTaskCompletedResponse>

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. --)

Parameters​
request​

IRespondQueryTaskCompletedRequest

Returns​

Promise<RespondQueryTaskCompletedResponse>

Properties​

name​

readonly name: "RespondQueryTaskCompleted"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondQueryTaskCompleted"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondQueryTaskCompletedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondQueryTaskCompletedResponse"

RespondQueryTaskCompletedCallback​

RespondQueryTaskCompletedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondQueryTaskCompletedResponse

RespondQueryTaskCompletedResponse

Returns​

void

RespondWorkflowTaskCompleted()​

RespondWorkflowTaskCompleted = void

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​

RespondWorkflowTaskCompleted(request, callback): void

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. --)

Parameters​
request​

IRespondWorkflowTaskCompletedRequest

callback​

RespondWorkflowTaskCompletedCallback

Returns​

void

Call Signature​

RespondWorkflowTaskCompleted(request): Promise<RespondWorkflowTaskCompletedResponse>

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. --)

Parameters​
request​

IRespondWorkflowTaskCompletedRequest

Returns​

Promise<RespondWorkflowTaskCompletedResponse>

Properties​

name​

readonly name: "RespondWorkflowTaskCompleted"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondWorkflowTaskCompleted"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondWorkflowTaskCompletedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondWorkflowTaskCompletedResponse"

RespondWorkflowTaskCompletedCallback​

RespondWorkflowTaskCompletedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondWorkflowTaskCompletedResponse

RespondWorkflowTaskCompletedResponse

Returns​

void

RespondWorkflowTaskFailed()​

RespondWorkflowTaskFailed = void

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​

RespondWorkflowTaskFailed(request, callback): void

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. --)

Parameters​
request​

IRespondWorkflowTaskFailedRequest

callback​

RespondWorkflowTaskFailedCallback

Returns​

void

Call Signature​

RespondWorkflowTaskFailed(request): Promise<RespondWorkflowTaskFailedResponse>

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. --)

Parameters​
request​

IRespondWorkflowTaskFailedRequest

Returns​

Promise<RespondWorkflowTaskFailedResponse>

Properties​

name​

readonly name: "RespondWorkflowTaskFailed"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/RespondWorkflowTaskFailed"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RespondWorkflowTaskFailedRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RespondWorkflowTaskFailedResponse"

RespondWorkflowTaskFailedCallback​

RespondWorkflowTaskFailedCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RespondWorkflowTaskFailedResponse

RespondWorkflowTaskFailedResponse

Returns​

void

ScanWorkflowExecutions()​

ScanWorkflowExecutions = void

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​

ScanWorkflowExecutions(request, callback): void

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. --)

Parameters​
request​

IScanWorkflowExecutionsRequest

callback​

ScanWorkflowExecutionsCallback

Returns​

void

Call Signature​

ScanWorkflowExecutions(request): Promise<ScanWorkflowExecutionsResponse>

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. --)

Parameters​
request​

IScanWorkflowExecutionsRequest

Returns​

Promise<ScanWorkflowExecutionsResponse>

Properties​

name​

readonly name: "ScanWorkflowExecutions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ScanWorkflowExecutions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ScanWorkflowExecutionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ScanWorkflowExecutionsResponse"

ScanWorkflowExecutionsCallback​

ScanWorkflowExecutionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse

Returns​

void

SetCurrentDeployment()​

SetCurrentDeployment = void

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​

SetCurrentDeployment(request, callback): void

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.

Parameters​
request​

ISetCurrentDeploymentRequest

callback​

SetCurrentDeploymentCallback

Returns​

void

Call Signature​

SetCurrentDeployment(request): Promise<SetCurrentDeploymentResponse>

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.

Parameters​
request​

ISetCurrentDeploymentRequest

Returns​

Promise<SetCurrentDeploymentResponse>

Properties​

name​

readonly name: "SetCurrentDeployment"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/SetCurrentDeployment"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetCurrentDeploymentRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetCurrentDeploymentResponse"

SetCurrentDeploymentCallback​

SetCurrentDeploymentCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetCurrentDeploymentResponse

SetCurrentDeploymentResponse

Returns​

void

SetWorkerDeploymentCurrentVersion()​

SetWorkerDeploymentCurrentVersion = void

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​

SetWorkerDeploymentCurrentVersion(request, callback): void

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

Parameters​
request​

ISetWorkerDeploymentCurrentVersionRequest

callback​

SetWorkerDeploymentCurrentVersionCallback

Returns​

void

Call Signature​

SetWorkerDeploymentCurrentVersion(request): Promise<SetWorkerDeploymentCurrentVersionResponse>

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

Parameters​
request​

ISetWorkerDeploymentCurrentVersionRequest

Returns​

Promise<SetWorkerDeploymentCurrentVersionResponse>

Properties​

name​

readonly name: "SetWorkerDeploymentCurrentVersion"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/SetWorkerDeploymentCurrentVersion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetWorkerDeploymentCurrentVersionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetWorkerDeploymentCurrentVersionResponse"

SetWorkerDeploymentCurrentVersionCallback​

SetWorkerDeploymentCurrentVersionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetWorkerDeploymentCurrentVersionResponse

SetWorkerDeploymentCurrentVersionResponse

Returns​

void

SetWorkerDeploymentManager()​

SetWorkerDeploymentManager = void

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

Call Signature​

SetWorkerDeploymentManager(request, callback): void

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

Parameters​
request​

ISetWorkerDeploymentManagerRequest

callback​

SetWorkerDeploymentManagerCallback

Returns​

void

Call Signature​

SetWorkerDeploymentManager(request): Promise<SetWorkerDeploymentManagerResponse>

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

Parameters​
request​

ISetWorkerDeploymentManagerRequest

Returns​

Promise<SetWorkerDeploymentManagerResponse>

Properties​

name​

readonly name: "SetWorkerDeploymentManager"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/SetWorkerDeploymentManager"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetWorkerDeploymentManagerRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetWorkerDeploymentManagerResponse"

SetWorkerDeploymentManagerCallback​

SetWorkerDeploymentManagerCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetWorkerDeploymentManagerResponse

SetWorkerDeploymentManagerResponse

Returns​

void

SetWorkerDeploymentRampingVersion()​

SetWorkerDeploymentRampingVersion = void

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​

SetWorkerDeploymentRampingVersion(request, callback): void

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

Parameters​
request​

ISetWorkerDeploymentRampingVersionRequest

callback​

SetWorkerDeploymentRampingVersionCallback

Returns​

void

Call Signature​

SetWorkerDeploymentRampingVersion(request): Promise<SetWorkerDeploymentRampingVersionResponse>

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

Parameters​
request​

ISetWorkerDeploymentRampingVersionRequest

Returns​

Promise<SetWorkerDeploymentRampingVersionResponse>

Properties​

name​

readonly name: "SetWorkerDeploymentRampingVersion"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/SetWorkerDeploymentRampingVersion"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SetWorkerDeploymentRampingVersionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SetWorkerDeploymentRampingVersionResponse"

SetWorkerDeploymentRampingVersionCallback​

SetWorkerDeploymentRampingVersionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SetWorkerDeploymentRampingVersionResponse

SetWorkerDeploymentRampingVersionResponse

Returns​

void

ShutdownWorker()​

ShutdownWorker = void

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​

ShutdownWorker(request, callback): void

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. --)

Parameters​
request​

IShutdownWorkerRequest

callback​

ShutdownWorkerCallback

Returns​

void

Call Signature​

ShutdownWorker(request): Promise<ShutdownWorkerResponse>

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. --)

Parameters​
request​

IShutdownWorkerRequest

Returns​

Promise<ShutdownWorkerResponse>

Properties​

name​

readonly name: "ShutdownWorker"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ShutdownWorker"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ShutdownWorkerRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ShutdownWorkerResponse"

ShutdownWorkerCallback​

ShutdownWorkerCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ShutdownWorkerResponse

ShutdownWorkerResponse

Returns​

void

SignalWithStartWorkflowExecution()​

SignalWithStartWorkflowExecution = void

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​

SignalWithStartWorkflowExecution(request, callback): void

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. --)

Parameters​
request​

ISignalWithStartWorkflowExecutionRequest

callback​

SignalWithStartWorkflowExecutionCallback

Returns​

void

Call Signature​

SignalWithStartWorkflowExecution(request): Promise<SignalWithStartWorkflowExecutionResponse>

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. --)

Parameters​
request​

ISignalWithStartWorkflowExecutionRequest

Returns​

Promise<SignalWithStartWorkflowExecutionResponse>

Properties​

name​

readonly name: "SignalWithStartWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/SignalWithStartWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SignalWithStartWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SignalWithStartWorkflowExecutionResponse"

SignalWithStartWorkflowExecutionCallback​

SignalWithStartWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SignalWithStartWorkflowExecutionResponse

SignalWithStartWorkflowExecutionResponse

Returns​

void

SignalWorkflowExecution()​

SignalWorkflowExecution = void

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​

SignalWorkflowExecution(request, callback): void

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.

Parameters​
request​

ISignalWorkflowExecutionRequest

callback​

SignalWorkflowExecutionCallback

Returns​

void

Call Signature​

SignalWorkflowExecution(request): Promise<SignalWorkflowExecutionResponse>

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.

Parameters​
request​

ISignalWorkflowExecutionRequest

Returns​

Promise<SignalWorkflowExecutionResponse>

Properties​

name​

readonly name: "SignalWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/SignalWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "SignalWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "SignalWorkflowExecutionResponse"

SignalWorkflowExecutionCallback​

SignalWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

SignalWorkflowExecutionResponse

SignalWorkflowExecutionResponse

Returns​

void

StartActivityExecution()​

StartActivityExecution = void

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​

StartActivityExecution(request, callback): void

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.

Parameters​
request​

IStartActivityExecutionRequest

callback​

StartActivityExecutionCallback

Returns​

void

Call Signature​

StartActivityExecution(request): Promise<StartActivityExecutionResponse>

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.

Parameters​
request​

IStartActivityExecutionRequest

Returns​

Promise<StartActivityExecutionResponse>

Properties​

name​

readonly name: "StartActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/StartActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "StartActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "StartActivityExecutionResponse"

StartActivityExecutionCallback​

StartActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

StartActivityExecutionResponse

StartActivityExecutionResponse

Returns​

void

StartBatchOperation()​

StartBatchOperation = void

StartBatchOperation starts a new batch operation

Call Signature​

StartBatchOperation(request, callback): void

StartBatchOperation starts a new batch operation

Parameters​
request​

IStartBatchOperationRequest

callback​

StartBatchOperationCallback

Returns​

void

Call Signature​

StartBatchOperation(request): Promise<StartBatchOperationResponse>

StartBatchOperation starts a new batch operation

Parameters​
request​

IStartBatchOperationRequest

Returns​

Promise<StartBatchOperationResponse>

Properties​

name​

readonly name: "StartBatchOperation"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/StartBatchOperation"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "StartBatchOperationRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "StartBatchOperationResponse"

StartBatchOperationCallback​

StartBatchOperationCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

StartBatchOperationResponse

StartBatchOperationResponse

Returns​

void

StartNexusOperationExecution()​

StartNexusOperationExecution = void

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​

StartNexusOperationExecution(request, callback): void

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.

Parameters​
request​

IStartNexusOperationExecutionRequest

callback​

StartNexusOperationExecutionCallback

Returns​

void

Call Signature​

StartNexusOperationExecution(request): Promise<StartNexusOperationExecutionResponse>

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.

Parameters​
request​

IStartNexusOperationExecutionRequest

Returns​

Promise<StartNexusOperationExecutionResponse>

Properties​

name​

readonly name: "StartNexusOperationExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/StartNexusOperationExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "StartNexusOperationExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "StartNexusOperationExecutionResponse"

StartNexusOperationExecutionCallback​

StartNexusOperationExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

StartNexusOperationExecutionResponse

StartNexusOperationExecutionResponse

Returns​

void

StartWorkflowExecution()​

StartWorkflowExecution = void

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​

StartWorkflowExecution(request, callback): void

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.

Parameters​
request​

IStartWorkflowExecutionRequest

callback​

StartWorkflowExecutionCallback

Returns​

void

Call Signature​

StartWorkflowExecution(request): Promise<StartWorkflowExecutionResponse>

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.

Parameters​
request​

IStartWorkflowExecutionRequest

Returns​

Promise<StartWorkflowExecutionResponse>

Properties​

name​

readonly name: "StartWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/StartWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "StartWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "StartWorkflowExecutionResponse"

StartWorkflowExecutionCallback​

StartWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

StartWorkflowExecutionResponse

StartWorkflowExecutionResponse

Returns​

void

StopBatchOperation()​

StopBatchOperation = void

StopBatchOperation stops a batch operation

Call Signature​

StopBatchOperation(request, callback): void

StopBatchOperation stops a batch operation

Parameters​
request​

IStopBatchOperationRequest

callback​

StopBatchOperationCallback

Returns​

void

Call Signature​

StopBatchOperation(request): Promise<StopBatchOperationResponse>

StopBatchOperation stops a batch operation

Parameters​
request​

IStopBatchOperationRequest

Returns​

Promise<StopBatchOperationResponse>

Properties​

name​

readonly name: "StopBatchOperation"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/StopBatchOperation"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "StopBatchOperationRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "StopBatchOperationResponse"

StopBatchOperationCallback​

StopBatchOperationCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

StopBatchOperationResponse

StopBatchOperationResponse

Returns​

void

TerminateActivityExecution()​

TerminateActivityExecution = void

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​

TerminateActivityExecution(request, callback): void

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.

Parameters​
request​

ITerminateActivityExecutionRequest

callback​

TerminateActivityExecutionCallback

Returns​

void

Call Signature​

TerminateActivityExecution(request): Promise<TerminateActivityExecutionResponse>

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.

Parameters​
request​

ITerminateActivityExecutionRequest

Returns​

Promise<TerminateActivityExecutionResponse>

Properties​

name​

readonly name: "TerminateActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/TerminateActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "TerminateActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "TerminateActivityExecutionResponse"

TerminateActivityExecutionCallback​

TerminateActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

TerminateActivityExecutionResponse

TerminateActivityExecutionResponse

Returns​

void

TerminateNexusOperationExecution()​

TerminateNexusOperationExecution = void

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​

TerminateNexusOperationExecution(request, callback): void

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.

Parameters​
request​

ITerminateNexusOperationExecutionRequest

callback​

TerminateNexusOperationExecutionCallback

Returns​

void

Call Signature​

TerminateNexusOperationExecution(request): Promise<TerminateNexusOperationExecutionResponse>

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.

Parameters​
request​

ITerminateNexusOperationExecutionRequest

Returns​

Promise<TerminateNexusOperationExecutionResponse>

Properties​

name​

readonly name: "TerminateNexusOperationExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/TerminateNexusOperationExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "TerminateNexusOperationExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "TerminateNexusOperationExecutionResponse"

TerminateNexusOperationExecutionCallback​

TerminateNexusOperationExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

TerminateNexusOperationExecutionResponse

TerminateNexusOperationExecutionResponse

Returns​

void

TerminateWorkflowExecution()​

TerminateWorkflowExecution = void

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

Call Signature​

TerminateWorkflowExecution(request, callback): void

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

Parameters​
request​

ITerminateWorkflowExecutionRequest

callback​

TerminateWorkflowExecutionCallback

Returns​

void

Call Signature​

TerminateWorkflowExecution(request): Promise<TerminateWorkflowExecutionResponse>

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

Parameters​
request​

ITerminateWorkflowExecutionRequest

Returns​

Promise<TerminateWorkflowExecutionResponse>

Properties​

name​

readonly name: "TerminateWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/TerminateWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "TerminateWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "TerminateWorkflowExecutionResponse"

TerminateWorkflowExecutionCallback​

TerminateWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

TerminateWorkflowExecutionResponse

TerminateWorkflowExecutionResponse

Returns​

void

TriggerWorkflowRule()​

TriggerWorkflowRule = void

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​

TriggerWorkflowRule(request, callback): void

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.
Parameters​
request​

ITriggerWorkflowRuleRequest

callback​

TriggerWorkflowRuleCallback

Returns​

void

Call Signature​

TriggerWorkflowRule(request): Promise<TriggerWorkflowRuleResponse>

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.
Parameters​
request​

ITriggerWorkflowRuleRequest

Returns​

Promise<TriggerWorkflowRuleResponse>

Properties​

name​

readonly name: "TriggerWorkflowRule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/TriggerWorkflowRule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "TriggerWorkflowRuleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "TriggerWorkflowRuleResponse"

TriggerWorkflowRuleCallback​

TriggerWorkflowRuleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

TriggerWorkflowRuleResponse

TriggerWorkflowRuleResponse

Returns​

void

UnpauseActivity()​

UnpauseActivity = void

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​

UnpauseActivity(request, callback): void

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.

Parameters​
request​

IUnpauseActivityRequest

callback​

UnpauseActivityCallback

Returns​

void

Call Signature​

UnpauseActivity(request): Promise<UnpauseActivityResponse>

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.

Parameters​
request​

IUnpauseActivityRequest

Returns​

Promise<UnpauseActivityResponse>

Properties​

name​

readonly name: "UnpauseActivity"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UnpauseActivity"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UnpauseActivityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UnpauseActivityResponse"

UnpauseActivityCallback​

UnpauseActivityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UnpauseActivityResponse

UnpauseActivityResponse

Returns​

void

UnpauseActivityExecution()​

UnpauseActivityExecution = void

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​

UnpauseActivityExecution(request, callback): void

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

Parameters​
request​

IUnpauseActivityExecutionRequest

callback​

UnpauseActivityExecutionCallback

Returns​

void

Call Signature​

UnpauseActivityExecution(request): Promise<UnpauseActivityExecutionResponse>

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

Parameters​
request​

IUnpauseActivityExecutionRequest

Returns​

Promise<UnpauseActivityExecutionResponse>

Properties​

name​

readonly name: "UnpauseActivityExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UnpauseActivityExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UnpauseActivityExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UnpauseActivityExecutionResponse"

UnpauseActivityExecutionCallback​

UnpauseActivityExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UnpauseActivityExecutionResponse

UnpauseActivityExecutionResponse

Returns​

void

UnpauseWorkflowExecution()​

UnpauseWorkflowExecution = void

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​

UnpauseWorkflowExecution(request, callback): void

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.
Parameters​
request​

IUnpauseWorkflowExecutionRequest

callback​

UnpauseWorkflowExecutionCallback

Returns​

void

Call Signature​

UnpauseWorkflowExecution(request): Promise<UnpauseWorkflowExecutionResponse>

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.
Parameters​
request​

IUnpauseWorkflowExecutionRequest

Returns​

Promise<UnpauseWorkflowExecutionResponse>

Properties​

name​

readonly name: "UnpauseWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UnpauseWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UnpauseWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UnpauseWorkflowExecutionResponse"

UnpauseWorkflowExecutionCallback​

UnpauseWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UnpauseWorkflowExecutionResponse

UnpauseWorkflowExecutionResponse

Returns​

void

UpdateActivityExecutionOptions()​

UpdateActivityExecutionOptions = void

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​

UpdateActivityExecutionOptions(request, callback): void

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.

Parameters​
request​

IUpdateActivityExecutionOptionsRequest

callback​

UpdateActivityExecutionOptionsCallback

Returns​

void

Call Signature​

UpdateActivityExecutionOptions(request): Promise<UpdateActivityExecutionOptionsResponse>

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.

Parameters​
request​

IUpdateActivityExecutionOptionsRequest

Returns​

Promise<UpdateActivityExecutionOptionsResponse>

Properties​

name​

readonly name: "UpdateActivityExecutionOptions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateActivityExecutionOptions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateActivityExecutionOptionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateActivityExecutionOptionsResponse"

UpdateActivityExecutionOptionsCallback​

UpdateActivityExecutionOptionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateActivityExecutionOptionsResponse

UpdateActivityExecutionOptionsResponse

Returns​

void

UpdateActivityOptions()​

UpdateActivityOptions = void

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​

UpdateActivityOptions(request, callback): void

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.

Parameters​
request​

IUpdateActivityOptionsRequest

callback​

UpdateActivityOptionsCallback

Returns​

void

Call Signature​

UpdateActivityOptions(request): Promise<UpdateActivityOptionsResponse>

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.

Parameters​
request​

IUpdateActivityOptionsRequest

Returns​

Promise<UpdateActivityOptionsResponse>

Properties​

name​

readonly name: "UpdateActivityOptions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateActivityOptions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateActivityOptionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateActivityOptionsResponse"

UpdateActivityOptionsCallback​

UpdateActivityOptionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateActivityOptionsResponse

UpdateActivityOptionsResponse

Returns​

void

UpdateNamespace()​

UpdateNamespace = void

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

Call Signature​

UpdateNamespace(request, callback): void

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

Parameters​
request​

IUpdateNamespaceRequest

callback​

UpdateNamespaceCallback

Returns​

void

Call Signature​

UpdateNamespace(request): Promise<UpdateNamespaceResponse>

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

Parameters​
request​

IUpdateNamespaceRequest

Returns​

Promise<UpdateNamespaceResponse>

Properties​

name​

readonly name: "UpdateNamespace"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateNamespaceResponse"

UpdateNamespaceCallback​

UpdateNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateNamespaceResponse

UpdateNamespaceResponse

Returns​

void

UpdateSchedule()​

UpdateSchedule = void

Changes the configuration or state of an existing schedule.

Call Signature​

UpdateSchedule(request, callback): void

Changes the configuration or state of an existing schedule.

Parameters​
request​

IUpdateScheduleRequest

callback​

UpdateScheduleCallback

Returns​

void

Call Signature​

UpdateSchedule(request): Promise<UpdateScheduleResponse>

Changes the configuration or state of an existing schedule.

Parameters​
request​

IUpdateScheduleRequest

Returns​

Promise<UpdateScheduleResponse>

Properties​

name​

readonly name: "UpdateSchedule"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateSchedule"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateScheduleRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateScheduleResponse"

UpdateScheduleCallback​

UpdateScheduleCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateScheduleResponse

UpdateScheduleResponse

Returns​

void

UpdateTaskQueueConfig()​

UpdateTaskQueueConfig = void

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​

UpdateTaskQueueConfig(request, callback): void

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.

Parameters​
request​

IUpdateTaskQueueConfigRequest

callback​

UpdateTaskQueueConfigCallback

Returns​

void

Call Signature​

UpdateTaskQueueConfig(request): Promise<UpdateTaskQueueConfigResponse>

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.

Parameters​
request​

IUpdateTaskQueueConfigRequest

Returns​

Promise<UpdateTaskQueueConfigResponse>

Properties​

name​

readonly name: "UpdateTaskQueueConfig"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateTaskQueueConfig"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateTaskQueueConfigRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateTaskQueueConfigResponse"

UpdateTaskQueueConfigCallback​

UpdateTaskQueueConfigCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateTaskQueueConfigResponse

UpdateTaskQueueConfigResponse

Returns​

void

UpdateWorkerBuildIdCompatibility()​

UpdateWorkerBuildIdCompatibility = void

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​

UpdateWorkerBuildIdCompatibility(request, callback): void

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. --)

Parameters​
request​

IUpdateWorkerBuildIdCompatibilityRequest

callback​

UpdateWorkerBuildIdCompatibilityCallback

Returns​

void

Call Signature​

UpdateWorkerBuildIdCompatibility(request): Promise<UpdateWorkerBuildIdCompatibilityResponse>

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. --)

Parameters​
request​

IUpdateWorkerBuildIdCompatibilityRequest

Returns​

Promise<UpdateWorkerBuildIdCompatibilityResponse>

Properties​

name​

readonly name: "UpdateWorkerBuildIdCompatibility"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerBuildIdCompatibility"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkerBuildIdCompatibilityRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkerBuildIdCompatibilityResponse"

UpdateWorkerBuildIdCompatibilityCallback​

UpdateWorkerBuildIdCompatibilityCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkerBuildIdCompatibilityResponse

UpdateWorkerBuildIdCompatibilityResponse

Returns​

void

UpdateWorkerConfig()​

UpdateWorkerConfig = void

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​

UpdateWorkerConfig(request, callback): void

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.

Parameters​
request​

IUpdateWorkerConfigRequest

callback​

UpdateWorkerConfigCallback

Returns​

void

Call Signature​

UpdateWorkerConfig(request): Promise<UpdateWorkerConfigResponse>

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.

Parameters​
request​

IUpdateWorkerConfigRequest

Returns​

Promise<UpdateWorkerConfigResponse>

Properties​

name​

readonly name: "UpdateWorkerConfig"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerConfig"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkerConfigRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkerConfigResponse"

UpdateWorkerConfigCallback​

UpdateWorkerConfigCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkerConfigResponse

UpdateWorkerConfigResponse

Returns​

void

UpdateWorkerDeploymentVersionComputeConfig()​

UpdateWorkerDeploymentVersionComputeConfig = void

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​

UpdateWorkerDeploymentVersionComputeConfig(request, callback): void

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

Parameters​
request​

IUpdateWorkerDeploymentVersionComputeConfigRequest

callback​

UpdateWorkerDeploymentVersionComputeConfigCallback

Returns​

void

Call Signature​

UpdateWorkerDeploymentVersionComputeConfig(request): Promise<UpdateWorkerDeploymentVersionComputeConfigResponse>

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

Parameters​
request​

IUpdateWorkerDeploymentVersionComputeConfigRequest

Returns​

Promise<UpdateWorkerDeploymentVersionComputeConfigResponse>

Properties​

name​

readonly name: "UpdateWorkerDeploymentVersionComputeConfig"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerDeploymentVersionComputeConfig"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkerDeploymentVersionComputeConfigRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkerDeploymentVersionComputeConfigResponse"

UpdateWorkerDeploymentVersionComputeConfigCallback​

UpdateWorkerDeploymentVersionComputeConfigCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkerDeploymentVersionComputeConfigResponse

UpdateWorkerDeploymentVersionComputeConfigResponse

Returns​

void

UpdateWorkerDeploymentVersionMetadata()​

UpdateWorkerDeploymentVersionMetadata = void

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

Call Signature​

UpdateWorkerDeploymentVersionMetadata(request, callback): void

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

Parameters​
request​

IUpdateWorkerDeploymentVersionMetadataRequest

callback​

UpdateWorkerDeploymentVersionMetadataCallback

Returns​

void

Call Signature​

UpdateWorkerDeploymentVersionMetadata(request): Promise<UpdateWorkerDeploymentVersionMetadataResponse>

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

Parameters​
request​

IUpdateWorkerDeploymentVersionMetadataRequest

Returns​

Promise<UpdateWorkerDeploymentVersionMetadataResponse>

Properties​

name​

readonly name: "UpdateWorkerDeploymentVersionMetadata"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerDeploymentVersionMetadata"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkerDeploymentVersionMetadataRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkerDeploymentVersionMetadataResponse"

UpdateWorkerDeploymentVersionMetadataCallback​

UpdateWorkerDeploymentVersionMetadataCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkerDeploymentVersionMetadataResponse

UpdateWorkerDeploymentVersionMetadataResponse

Returns​

void

UpdateWorkerVersioningRules()​

UpdateWorkerVersioningRules = void

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​

UpdateWorkerVersioningRules(request, callback): void

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. --)

Parameters​
request​

IUpdateWorkerVersioningRulesRequest

callback​

UpdateWorkerVersioningRulesCallback

Returns​

void

Call Signature​

UpdateWorkerVersioningRules(request): Promise<UpdateWorkerVersioningRulesResponse>

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. --)

Parameters​
request​

IUpdateWorkerVersioningRulesRequest

Returns​

Promise<UpdateWorkerVersioningRulesResponse>

Properties​

name​

readonly name: "UpdateWorkerVersioningRules"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkerVersioningRules"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkerVersioningRulesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkerVersioningRulesResponse"

UpdateWorkerVersioningRulesCallback​

UpdateWorkerVersioningRulesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkerVersioningRulesResponse

UpdateWorkerVersioningRulesResponse

Returns​

void

UpdateWorkflowExecution()​

UpdateWorkflowExecution = void

Invokes the specified Update function on user Workflow code.

Call Signature​

UpdateWorkflowExecution(request, callback): void

Invokes the specified Update function on user Workflow code.

Parameters​
request​

IUpdateWorkflowExecutionRequest

callback​

UpdateWorkflowExecutionCallback

Returns​

void

Call Signature​

UpdateWorkflowExecution(request): Promise<UpdateWorkflowExecutionResponse>

Invokes the specified Update function on user Workflow code.

Parameters​
request​

IUpdateWorkflowExecutionRequest

Returns​

Promise<UpdateWorkflowExecutionResponse>

Properties​

name​

readonly name: "UpdateWorkflowExecution"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkflowExecution"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkflowExecutionRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkflowExecutionResponse"

UpdateWorkflowExecutionCallback​

UpdateWorkflowExecutionCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkflowExecutionResponse

UpdateWorkflowExecutionResponse

Returns​

void

UpdateWorkflowExecutionOptions()​

UpdateWorkflowExecutionOptions = void

UpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.

Call Signature​

UpdateWorkflowExecutionOptions(request, callback): void

UpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.

Parameters​
request​

IUpdateWorkflowExecutionOptionsRequest

callback​

UpdateWorkflowExecutionOptionsCallback

Returns​

void

Call Signature​

UpdateWorkflowExecutionOptions(request): Promise<UpdateWorkflowExecutionOptionsResponse>

UpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.

Parameters​
request​

IUpdateWorkflowExecutionOptionsRequest

Returns​

Promise<UpdateWorkflowExecutionOptionsResponse>

Properties​

name​

readonly name: "UpdateWorkflowExecutionOptions"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/UpdateWorkflowExecutionOptions"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateWorkflowExecutionOptionsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateWorkflowExecutionOptionsResponse"

UpdateWorkflowExecutionOptionsCallback​

UpdateWorkflowExecutionOptionsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateWorkflowExecutionOptionsResponse

UpdateWorkflowExecutionOptionsResponse

Returns​

void

ValidateWorkerDeploymentVersionComputeConfig()​

ValidateWorkerDeploymentVersionComputeConfig = void

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​

ValidateWorkerDeploymentVersionComputeConfig(request, callback): void

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.

Parameters​
request​

IValidateWorkerDeploymentVersionComputeConfigRequest

callback​

ValidateWorkerDeploymentVersionComputeConfigCallback

Returns​

void

Call Signature​

ValidateWorkerDeploymentVersionComputeConfig(request): Promise<ValidateWorkerDeploymentVersionComputeConfigResponse>

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.

Parameters​
request​

IValidateWorkerDeploymentVersionComputeConfigRequest

Returns​

Promise<ValidateWorkerDeploymentVersionComputeConfigResponse>

Properties​

name​

readonly name: "ValidateWorkerDeploymentVersionComputeConfig"

path​

readonly path: "/temporal.api.workflowservice.v1.WorkflowService/ValidateWorkerDeploymentVersionComputeConfig"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ValidateWorkerDeploymentVersionComputeConfigRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ValidateWorkerDeploymentVersionComputeConfigResponse"

ValidateWorkerDeploymentVersionComputeConfigCallback​

ValidateWorkerDeploymentVersionComputeConfigCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ValidateWorkerDeploymentVersionComputeConfigResponse

ValidateWorkerDeploymentVersionComputeConfigResponse

Returns​

void