Namespace: WorkflowService
workflowservice.v1.WorkflowService
Type Aliases
CountWorkflowExecutionsCallback
Ƭ CountWorkflowExecutionsCallback: (error: Error | null, response?: CountWorkflowExecutionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#countWorkflowExecutions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CountWorkflowExecutionsResponse | CountWorkflowExecutionsResponse |
Returns
void
CreateScheduleCallback
Ƭ CreateScheduleCallback: (error: Error | null, response?: CreateScheduleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#createSchedule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateScheduleResponse | CreateScheduleResponse |
Returns
void
CreateWorkflowRuleCallback
Ƭ CreateWorkflowRuleCallback: (error: Error | null, response?: CreateWorkflowRuleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#createWorkflowRule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | CreateWorkflowRuleResponse | CreateWorkflowRuleResponse |
Returns
void
DeleteScheduleCallback
Ƭ DeleteScheduleCallback: (error: Error | null, response?: DeleteScheduleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteSchedule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteScheduleResponse | DeleteScheduleResponse |
Returns
void
DeleteWorkerDeploymentCallback
Ƭ DeleteWorkerDeploymentCallback: (error: Error | null, response?: DeleteWorkerDeploymentResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkerDeployment.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteWorkerDeploymentResponse | DeleteWorkerDeploymentResponse |
Returns
void
DeleteWorkerDeploymentVersionCallback
Ƭ DeleteWorkerDeploymentVersionCallback: (error: Error | null, response?: DeleteWorkerDeploymentVersionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkerDeploymentVersion.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteWorkerDeploymentVersionResponse | DeleteWorkerDeploymentVersionResponse |
Returns
void
DeleteWorkflowExecutionCallback
Ƭ DeleteWorkflowExecutionCallback: (error: Error | null, response?: DeleteWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteWorkflowExecutionResponse | DeleteWorkflowExecutionResponse |
Returns
void
DeleteWorkflowRuleCallback
Ƭ DeleteWorkflowRuleCallback: (error: Error | null, response?: DeleteWorkflowRuleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#deleteWorkflowRule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeleteWorkflowRuleResponse | DeleteWorkflowRuleResponse |
Returns
void
DeprecateNamespaceCallback
Ƭ DeprecateNamespaceCallback: (error: Error | null, response?: DeprecateNamespaceResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#deprecateNamespace.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DeprecateNamespaceResponse | DeprecateNamespaceResponse |
Returns
void
DescribeBatchOperationCallback
Ƭ DescribeBatchOperationCallback: (error: Error | null, response?: DescribeBatchOperationResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeBatchOperation.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeBatchOperationResponse | DescribeBatchOperationResponse |
Returns
void
DescribeDeploymentCallback
Ƭ DescribeDeploymentCallback: (error: Error | null, response?: DescribeDeploymentResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeDeployment.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeDeploymentResponse | DescribeDeploymentResponse |
Returns
void
DescribeNamespaceCallback
Ƭ DescribeNamespaceCallback: (error: Error | null, response?: DescribeNamespaceResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeNamespace.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeNamespaceResponse | DescribeNamespaceResponse |
Returns
void
DescribeScheduleCallback
Ƭ DescribeScheduleCallback: (error: Error | null, response?: DescribeScheduleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeSchedule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeScheduleResponse | DescribeScheduleResponse |
Returns
void
DescribeTaskQueueCallback
Ƭ DescribeTaskQueueCallback: (error: Error | null, response?: DescribeTaskQueueResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeTaskQueue.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeTaskQueueResponse | DescribeTaskQueueResponse |
Returns
void
DescribeWorkerDeploymentCallback
Ƭ DescribeWorkerDeploymentCallback: (error: Error | null, response?: DescribeWorkerDeploymentResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkerDeployment.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeWorkerDeploymentResponse | DescribeWorkerDeploymentResponse |
Returns
void
DescribeWorkerDeploymentVersionCallback
Ƭ DescribeWorkerDeploymentVersionCallback: (error: Error | null, response?: DescribeWorkerDeploymentVersionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkerDeploymentVersion.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeWorkerDeploymentVersionResponse | DescribeWorkerDeploymentVersionResponse |
Returns
void
DescribeWorkflowExecutionCallback
Ƭ DescribeWorkflowExecutionCallback: (error: Error | null, response?: DescribeWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeWorkflowExecutionResponse | DescribeWorkflowExecutionResponse |
Returns
void
DescribeWorkflowRuleCallback
Ƭ DescribeWorkflowRuleCallback: (error: Error | null, response?: DescribeWorkflowRuleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#describeWorkflowRule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | DescribeWorkflowRuleResponse | DescribeWorkflowRuleResponse |
Returns
void
ExecuteMultiOperationCallback
Ƭ ExecuteMultiOperationCallback: (error: Error | null, response?: ExecuteMultiOperationResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#executeMultiOperation.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ExecuteMultiOperationResponse | ExecuteMultiOperationResponse |
Returns
void
FetchWorkerConfigCallback
Ƭ FetchWorkerConfigCallback: (error: Error | null, response?: FetchWorkerConfigResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#fetchWorkerConfig.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | FetchWorkerConfigResponse | FetchWorkerConfigResponse |
Returns
void
GetClusterInfoCallback
Ƭ GetClusterInfoCallback: (error: Error | null, response?: GetClusterInfoResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getClusterInfo.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetClusterInfoResponse | GetClusterInfoResponse |
Returns
void
GetCurrentDeploymentCallback
Ƭ GetCurrentDeploymentCallback: (error: Error | null, response?: GetCurrentDeploymentResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getCurrentDeployment.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetCurrentDeploymentResponse | GetCurrentDeploymentResponse |
Returns
void
GetDeploymentReachabilityCallback
Ƭ GetDeploymentReachabilityCallback: (error: Error | null, response?: GetDeploymentReachabilityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getDeploymentReachability.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetDeploymentReachabilityResponse | GetDeploymentReachabilityResponse |
Returns
void
GetSearchAttributesCallback
Ƭ GetSearchAttributesCallback: (error: Error | null, response?: GetSearchAttributesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getSearchAttributes.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetSearchAttributesResponse | GetSearchAttributesResponse |
Returns
void
GetSystemInfoCallback
Ƭ GetSystemInfoCallback: (error: Error | null, response?: GetSystemInfoResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getSystemInfo.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetSystemInfoResponse | GetSystemInfoResponse |
Returns
void
GetWorkerBuildIdCompatibilityCallback
Ƭ GetWorkerBuildIdCompatibilityCallback: (error: Error | null, response?: GetWorkerBuildIdCompatibilityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkerBuildIdCompatibility.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetWorkerBuildIdCompatibilityResponse | GetWorkerBuildIdCompatibilityResponse |
Returns
void
GetWorkerTaskReachabilityCallback
Ƭ GetWorkerTaskReachabilityCallback: (error: Error | null, response?: GetWorkerTaskReachabilityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkerTaskReachability.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetWorkerTaskReachabilityResponse | GetWorkerTaskReachabilityResponse |
Returns
void
GetWorkerVersioningRulesCallback
Ƭ GetWorkerVersioningRulesCallback: (error: Error | null, response?: GetWorkerVersioningRulesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkerVersioningRules.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetWorkerVersioningRulesResponse | GetWorkerVersioningRulesResponse |
Returns
void
GetWorkflowExecutionHistoryCallback
Ƭ GetWorkflowExecutionHistoryCallback: (error: Error | null, response?: GetWorkflowExecutionHistoryResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkflowExecutionHistory.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetWorkflowExecutionHistoryResponse | GetWorkflowExecutionHistoryResponse |
Returns
void
GetWorkflowExecutionHistoryReverseCallback
Ƭ GetWorkflowExecutionHistoryReverseCallback: (error: Error | null, response?: GetWorkflowExecutionHistoryReverseResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#getWorkflowExecutionHistoryReverse.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | GetWorkflowExecutionHistoryReverseResponse | GetWorkflowExecutionHistoryReverseResponse |
Returns
void
ListArchivedWorkflowExecutionsCallback
Ƭ ListArchivedWorkflowExecutionsCallback: (error: Error | null, response?: ListArchivedWorkflowExecutionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listArchivedWorkflowExecutions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListArchivedWorkflowExecutionsResponse | ListArchivedWorkflowExecutionsResponse |
Returns
void
ListBatchOperationsCallback
Ƭ ListBatchOperationsCallback: (error: Error | null, response?: ListBatchOperationsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listBatchOperations.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListBatchOperationsResponse | ListBatchOperationsResponse |
Returns
void
ListClosedWorkflowExecutionsCallback
Ƭ ListClosedWorkflowExecutionsCallback: (error: Error | null, response?: ListClosedWorkflowExecutionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listClosedWorkflowExecutions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListClosedWorkflowExecutionsResponse | ListClosedWorkflowExecutionsResponse |
Returns
void
ListDeploymentsCallback
Ƭ ListDeploymentsCallback: (error: Error | null, response?: ListDeploymentsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listDeployments.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListDeploymentsResponse | ListDeploymentsResponse |
Returns
void
ListNamespacesCallback
Ƭ ListNamespacesCallback: (error: Error | null, response?: ListNamespacesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listNamespaces.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListNamespacesResponse | ListNamespacesResponse |
Returns
void
ListOpenWorkflowExecutionsCallback
Ƭ ListOpenWorkflowExecutionsCallback: (error: Error | null, response?: ListOpenWorkflowExecutionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listOpenWorkflowExecutions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListOpenWorkflowExecutionsResponse | ListOpenWorkflowExecutionsResponse |
Returns
void
ListScheduleMatchingTimesCallback
Ƭ ListScheduleMatchingTimesCallback: (error: Error | null, response?: ListScheduleMatchingTimesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listScheduleMatchingTimes.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListScheduleMatchingTimesResponse | ListScheduleMatchingTimesResponse |
Returns
void
ListSchedulesCallback
Ƭ ListSchedulesCallback: (error: Error | null, response?: ListSchedulesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listSchedules.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListSchedulesResponse | ListSchedulesResponse |
Returns
void
ListTaskQueuePartitionsCallback
Ƭ ListTaskQueuePartitionsCallback: (error: Error | null, response?: ListTaskQueuePartitionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listTaskQueuePartitions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListTaskQueuePartitionsResponse | ListTaskQueuePartitionsResponse |
Returns
void
ListWorkerDeploymentsCallback
Ƭ ListWorkerDeploymentsCallback: (error: Error | null, response?: ListWorkerDeploymentsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkerDeployments.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListWorkerDeploymentsResponse | ListWorkerDeploymentsResponse |
Returns
void
ListWorkersCallback
Ƭ ListWorkersCallback: (error: Error | null, response?: ListWorkersResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkers.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListWorkersResponse | ListWorkersResponse |
Returns
void
ListWorkflowExecutionsCallback
Ƭ ListWorkflowExecutionsCallback: (error: Error | null, response?: ListWorkflowExecutionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkflowExecutions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListWorkflowExecutionsResponse | ListWorkflowExecutionsResponse |
Returns
void
ListWorkflowRulesCallback
Ƭ ListWorkflowRulesCallback: (error: Error | null, response?: ListWorkflowRulesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#listWorkflowRules.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ListWorkflowRulesResponse | ListWorkflowRulesResponse |
Returns
void
PatchScheduleCallback
Ƭ PatchScheduleCallback: (error: Error | null, response?: PatchScheduleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#patchSchedule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | PatchScheduleResponse | PatchScheduleResponse |
Returns
void
PauseActivityCallback
Ƭ PauseActivityCallback: (error: Error | null, response?: PauseActivityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#pauseActivity.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | PauseActivityResponse | PauseActivityResponse |
Returns
void
PollActivityTaskQueueCallback
Ƭ PollActivityTaskQueueCallback: (error: Error | null, response?: PollActivityTaskQueueResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollActivityTaskQueue.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | PollActivityTaskQueueResponse | PollActivityTaskQueueResponse |
Returns
void
PollNexusTaskQueueCallback
Ƭ PollNexusTaskQueueCallback: (error: Error | null, response?: PollNexusTaskQueueResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollNexusTaskQueue.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | PollNexusTaskQueueResponse | PollNexusTaskQueueResponse |
Returns
void
PollWorkflowExecutionUpdateCallback
Ƭ PollWorkflowExecutionUpdateCallback: (error: Error | null, response?: PollWorkflowExecutionUpdateResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollWorkflowExecutionUpdate.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | PollWorkflowExecutionUpdateResponse | PollWorkflowExecutionUpdateResponse |
Returns
void
PollWorkflowTaskQueueCallback
Ƭ PollWorkflowTaskQueueCallback: (error: Error | null, response?: PollWorkflowTaskQueueResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#pollWorkflowTaskQueue.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | PollWorkflowTaskQueueResponse | PollWorkflowTaskQueueResponse |
Returns
void
QueryWorkflowCallback
Ƭ QueryWorkflowCallback: (error: Error | null, response?: QueryWorkflowResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#queryWorkflow.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | QueryWorkflowResponse | QueryWorkflowResponse |
Returns
void
RecordActivityTaskHeartbeatByIdCallback
Ƭ RecordActivityTaskHeartbeatByIdCallback: (error: Error | null, response?: RecordActivityTaskHeartbeatByIdResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#recordActivityTaskHeartbeatById.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RecordActivityTaskHeartbeatByIdResponse | RecordActivityTaskHeartbeatByIdResponse |
Returns
void
RecordActivityTaskHeartbeatCallback
Ƭ RecordActivityTaskHeartbeatCallback: (error: Error | null, response?: RecordActivityTaskHeartbeatResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#recordActivityTaskHeartbeat.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RecordActivityTaskHeartbeatResponse | RecordActivityTaskHeartbeatResponse |
Returns
void
RecordWorkerHeartbeatCallback
Ƭ RecordWorkerHeartbeatCallback: (error: Error | null, response?: RecordWorkerHeartbeatResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#recordWorkerHeartbeat.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RecordWorkerHeartbeatResponse | RecordWorkerHeartbeatResponse |
Returns
void
RegisterNamespaceCallback
Ƭ RegisterNamespaceCallback: (error: Error | null, response?: RegisterNamespaceResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#registerNamespace.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RegisterNamespaceResponse | RegisterNamespaceResponse |
Returns
void
RequestCancelWorkflowExecutionCallback
Ƭ RequestCancelWorkflowExecutionCallback: (error: Error | null, response?: RequestCancelWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#requestCancelWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RequestCancelWorkflowExecutionResponse | RequestCancelWorkflowExecutionResponse |
Returns
void
ResetActivityCallback
Ƭ ResetActivityCallback: (error: Error | null, response?: ResetActivityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetActivity.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ResetActivityResponse | ResetActivityResponse |
Returns
void
ResetStickyTaskQueueCallback
Ƭ ResetStickyTaskQueueCallback: (error: Error | null, response?: ResetStickyTaskQueueResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetStickyTaskQueue.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ResetStickyTaskQueueResponse | ResetStickyTaskQueueResponse |
Returns
void
ResetWorkflowExecutionCallback
Ƭ ResetWorkflowExecutionCallback: (error: Error | null, response?: ResetWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#resetWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ResetWorkflowExecutionResponse | ResetWorkflowExecutionResponse |
Returns
void
RespondActivityTaskCanceledByIdCallback
Ƭ RespondActivityTaskCanceledByIdCallback: (error: Error | null, response?: RespondActivityTaskCanceledByIdResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCanceledById.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondActivityTaskCanceledByIdResponse | RespondActivityTaskCanceledByIdResponse |
Returns
void
RespondActivityTaskCanceledCallback
Ƭ RespondActivityTaskCanceledCallback: (error: Error | null, response?: RespondActivityTaskCanceledResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCanceled.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondActivityTaskCanceledResponse | RespondActivityTaskCanceledResponse |
Returns
void
RespondActivityTaskCompletedByIdCallback
Ƭ RespondActivityTaskCompletedByIdCallback: (error: Error | null, response?: RespondActivityTaskCompletedByIdResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCompletedById.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondActivityTaskCompletedByIdResponse | RespondActivityTaskCompletedByIdResponse |
Returns
void
RespondActivityTaskCompletedCallback
Ƭ RespondActivityTaskCompletedCallback: (error: Error | null, response?: RespondActivityTaskCompletedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCompleted.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondActivityTaskCompletedResponse | RespondActivityTaskCompletedResponse |
Returns
void
RespondActivityTaskFailedByIdCallback
Ƭ RespondActivityTaskFailedByIdCallback: (error: Error | null, response?: RespondActivityTaskFailedByIdResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskFailedById.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondActivityTaskFailedByIdResponse | RespondActivityTaskFailedByIdResponse |
Returns
void
RespondActivityTaskFailedCallback
Ƭ RespondActivityTaskFailedCallback: (error: Error | null, response?: RespondActivityTaskFailedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskFailed.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondActivityTaskFailedResponse | RespondActivityTaskFailedResponse |
Returns
void
RespondNexusTaskCompletedCallback
Ƭ RespondNexusTaskCompletedCallback: (error: Error | null, response?: RespondNexusTaskCompletedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondNexusTaskCompleted.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondNexusTaskCompletedResponse | RespondNexusTaskCompletedResponse |
Returns
void
RespondNexusTaskFailedCallback
Ƭ RespondNexusTaskFailedCallback: (error: Error | null, response?: RespondNexusTaskFailedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondNexusTaskFailed.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondNexusTaskFailedResponse | RespondNexusTaskFailedResponse |
Returns
void
RespondQueryTaskCompletedCallback
Ƭ RespondQueryTaskCompletedCallback: (error: Error | null, response?: RespondQueryTaskCompletedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondQueryTaskCompleted.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondQueryTaskCompletedResponse | RespondQueryTaskCompletedResponse |
Returns
void
RespondWorkflowTaskCompletedCallback
Ƭ RespondWorkflowTaskCompletedCallback: (error: Error | null, response?: RespondWorkflowTaskCompletedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondWorkflowTaskCompleted.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondWorkflowTaskCompletedResponse | RespondWorkflowTaskCompletedResponse |
Returns
void
RespondWorkflowTaskFailedCallback
Ƭ RespondWorkflowTaskFailedCallback: (error: Error | null, response?: RespondWorkflowTaskFailedResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#respondWorkflowTaskFailed.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | RespondWorkflowTaskFailedResponse | RespondWorkflowTaskFailedResponse |
Returns
void
ScanWorkflowExecutionsCallback
Ƭ ScanWorkflowExecutionsCallback: (error: Error | null, response?: ScanWorkflowExecutionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#scanWorkflowExecutions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ScanWorkflowExecutionsResponse | ScanWorkflowExecutionsResponse |
Returns
void
SetCurrentDeploymentCallback
Ƭ SetCurrentDeploymentCallback: (error: Error | null, response?: SetCurrentDeploymentResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#setCurrentDeployment.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SetCurrentDeploymentResponse | SetCurrentDeploymentResponse |
Returns
void
SetWorkerDeploymentCurrentVersionCallback
Ƭ SetWorkerDeploymentCurrentVersionCallback: (error: Error | null, response?: SetWorkerDeploymentCurrentVersionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#setWorkerDeploymentCurrentVersion.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SetWorkerDeploymentCurrentVersionResponse | SetWorkerDeploymentCurrentVersionResponse |
Returns
void
SetWorkerDeploymentRampingVersionCallback
Ƭ SetWorkerDeploymentRampingVersionCallback: (error: Error | null, response?: SetWorkerDeploymentRampingVersionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#setWorkerDeploymentRampingVersion.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SetWorkerDeploymentRampingVersionResponse | SetWorkerDeploymentRampingVersionResponse |
Returns
void
ShutdownWorkerCallback
Ƭ ShutdownWorkerCallback: (error: Error | null, response?: ShutdownWorkerResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#shutdownWorker.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | ShutdownWorkerResponse | ShutdownWorkerResponse |
Returns
void
SignalWithStartWorkflowExecutionCallback
Ƭ SignalWithStartWorkflowExecutionCallback: (error: Error | null, response?: SignalWithStartWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#signalWithStartWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SignalWithStartWorkflowExecutionResponse | SignalWithStartWorkflowExecutionResponse |
Returns
void
SignalWorkflowExecutionCallback
Ƭ SignalWorkflowExecutionCallback: (error: Error | null, response?: SignalWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#signalWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | SignalWorkflowExecutionResponse | SignalWorkflowExecutionResponse |
Returns
void
StartBatchOperationCallback
Ƭ StartBatchOperationCallback: (error: Error | null, response?: StartBatchOperationResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#startBatchOperation.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | StartBatchOperationResponse | StartBatchOperationResponse |
Returns
void
StartWorkflowExecutionCallback
Ƭ StartWorkflowExecutionCallback: (error: Error | null, response?: StartWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#startWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | StartWorkflowExecutionResponse | StartWorkflowExecutionResponse |
Returns
void
StopBatchOperationCallback
Ƭ StopBatchOperationCallback: (error: Error | null, response?: StopBatchOperationResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#stopBatchOperation.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | StopBatchOperationResponse | StopBatchOperationResponse |
Returns
void
TerminateWorkflowExecutionCallback
Ƭ TerminateWorkflowExecutionCallback: (error: Error | null, response?: TerminateWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#terminateWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | TerminateWorkflowExecutionResponse | TerminateWorkflowExecutionResponse |
Returns
void
TriggerWorkflowRuleCallback
Ƭ TriggerWorkflowRuleCallback: (error: Error | null, response?: TriggerWorkflowRuleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#triggerWorkflowRule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | TriggerWorkflowRuleResponse | TriggerWorkflowRuleResponse |
Returns
void
UnpauseActivityCallback
Ƭ UnpauseActivityCallback: (error: Error | null, response?: UnpauseActivityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#unpauseActivity.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UnpauseActivityResponse | UnpauseActivityResponse |
Returns
void
UpdateActivityOptionsCallback
Ƭ UpdateActivityOptionsCallback: (error: Error | null, response?: UpdateActivityOptionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateActivityOptions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateActivityOptionsResponse | UpdateActivityOptionsResponse |
Returns
void
UpdateNamespaceCallback
Ƭ UpdateNamespaceCallback: (error: Error | null, response?: UpdateNamespaceResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateNamespace.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateNamespaceResponse | UpdateNamespaceResponse |
Returns
void
UpdateScheduleCallback
Ƭ UpdateScheduleCallback: (error: Error | null, response?: UpdateScheduleResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateSchedule.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateScheduleResponse | UpdateScheduleResponse |
Returns
void
UpdateTaskQueueConfigCallback
Ƭ UpdateTaskQueueConfigCallback: (error: Error | null, response?: UpdateTaskQueueConfigResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateTaskQueueConfig.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateTaskQueueConfigResponse | UpdateTaskQueueConfigResponse |
Returns
void
UpdateWorkerBuildIdCompatibilityCallback
Ƭ UpdateWorkerBuildIdCompatibilityCallback: (error: Error | null, response?: UpdateWorkerBuildIdCompatibilityResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerBuildIdCompatibility.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateWorkerBuildIdCompatibilityResponse | UpdateWorkerBuildIdCompatibilityResponse |
Returns
void
UpdateWorkerConfigCallback
Ƭ UpdateWorkerConfigCallback: (error: Error | null, response?: UpdateWorkerConfigResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerConfig.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateWorkerConfigResponse | UpdateWorkerConfigResponse |
Returns
void
UpdateWorkerDeploymentVersionMetadataCallback
Ƭ UpdateWorkerDeploymentVersionMetadataCallback: (error: Error | null, response?: UpdateWorkerDeploymentVersionMetadataResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerDeploymentVersionMetadata.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateWorkerDeploymentVersionMetadataResponse | UpdateWorkerDeploymentVersionMetadataResponse |
Returns
void
UpdateWorkerVersioningRulesCallback
Ƭ UpdateWorkerVersioningRulesCallback: (error: Error | null, response?: UpdateWorkerVersioningRulesResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkerVersioningRules.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateWorkerVersioningRulesResponse | UpdateWorkerVersioningRulesResponse |
Returns
void
UpdateWorkflowExecutionCallback
Ƭ UpdateWorkflowExecutionCallback: (error: Error | null, response?: UpdateWorkflowExecutionResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkflowExecution.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateWorkflowExecutionResponse | UpdateWorkflowExecutionResponse |
Returns
void
UpdateWorkflowExecutionOptionsCallback
Ƭ UpdateWorkflowExecutionOptionsCallback: (error: Error | null, response?: UpdateWorkflowExecutionOptionsResponse) => void
Callback as used by temporal.api.workflowservice.v1.WorkflowService#updateWorkflowExecutionOptions.
Type declaration
▸ (error, response?): void
Parameters
| Name | Type | Description |
|---|---|---|
error | Error | null | Error, if any |
response? | UpdateWorkflowExecutionOptionsResponse | UpdateWorkflowExecutionOptionsResponse |
Returns
void