Skip to main content

Namespace: WorkflowService

workflowservice.v1.WorkflowService

Type aliases#

CountWorkflowExecutionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#countWorkflowExecutions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?CountWorkflowExecutionsResponse-
Returns#

void


DeprecateNamespaceCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#deprecateNamespace}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?DeprecateNamespaceResponse-
Returns#

void


DescribeNamespaceCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#describeNamespace}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?DescribeNamespaceResponse-
Returns#

void


DescribeTaskQueueCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#describeTaskQueue}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?DescribeTaskQueueResponse-
Returns#

void


DescribeWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#describeWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?DescribeWorkflowExecutionResponse-
Returns#

void


GetClusterInfoCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#getClusterInfo}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?GetClusterInfoResponse-
Returns#

void


GetSearchAttributesCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#getSearchAttributes}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?GetSearchAttributesResponse-
Returns#

void


GetWorkflowExecutionHistoryCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#getWorkflowExecutionHistory}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?GetWorkflowExecutionHistoryResponse-
Returns#

void


ListArchivedWorkflowExecutionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#listArchivedWorkflowExecutions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ListArchivedWorkflowExecutionsResponse-
Returns#

void


ListClosedWorkflowExecutionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#listClosedWorkflowExecutions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ListClosedWorkflowExecutionsResponse-
Returns#

void


ListNamespacesCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#listNamespaces}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ListNamespacesResponse-
Returns#

void


ListOpenWorkflowExecutionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#listOpenWorkflowExecutions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ListOpenWorkflowExecutionsResponse-
Returns#

void


ListTaskQueuePartitionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#listTaskQueuePartitions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ListTaskQueuePartitionsResponse-
Returns#

void


ListWorkflowExecutionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#listWorkflowExecutions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ListWorkflowExecutionsResponse-
Returns#

void


PollActivityTaskQueueCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#pollActivityTaskQueue}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?PollActivityTaskQueueResponse-
Returns#

void


PollWorkflowTaskQueueCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#pollWorkflowTaskQueue}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?PollWorkflowTaskQueueResponse-
Returns#

void


QueryWorkflowCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#queryWorkflow}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?QueryWorkflowResponse-
Returns#

void


RecordActivityTaskHeartbeatByIdCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#recordActivityTaskHeartbeatById}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RecordActivityTaskHeartbeatByIdResponse-
Returns#

void


RecordActivityTaskHeartbeatCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#recordActivityTaskHeartbeat}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RecordActivityTaskHeartbeatResponse-
Returns#

void


RegisterNamespaceCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#registerNamespace}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RegisterNamespaceResponse-
Returns#

void


RequestCancelWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#requestCancelWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RequestCancelWorkflowExecutionResponse-
Returns#

void


ResetStickyTaskQueueCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#resetStickyTaskQueue}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ResetStickyTaskQueueResponse-
Returns#

void


ResetWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#resetWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ResetWorkflowExecutionResponse-
Returns#

void


RespondActivityTaskCanceledByIdCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCanceledById}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondActivityTaskCanceledByIdResponse-
Returns#

void


RespondActivityTaskCanceledCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCanceled}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondActivityTaskCanceledResponse-
Returns#

void


RespondActivityTaskCompletedByIdCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCompletedById}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondActivityTaskCompletedByIdResponse-
Returns#

void


RespondActivityTaskCompletedCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskCompleted}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondActivityTaskCompletedResponse-
Returns#

void


RespondActivityTaskFailedByIdCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskFailedById}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondActivityTaskFailedByIdResponse-
Returns#

void


RespondActivityTaskFailedCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondActivityTaskFailed}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondActivityTaskFailedResponse-
Returns#

void


RespondQueryTaskCompletedCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondQueryTaskCompleted}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondQueryTaskCompletedResponse-
Returns#

void


RespondWorkflowTaskCompletedCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondWorkflowTaskCompleted}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondWorkflowTaskCompletedResponse-
Returns#

void


RespondWorkflowTaskFailedCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#respondWorkflowTaskFailed}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?RespondWorkflowTaskFailedResponse-
Returns#

void


ScanWorkflowExecutionsCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#scanWorkflowExecutions}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?ScanWorkflowExecutionsResponse-
Returns#

void


SignalWithStartWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#signalWithStartWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?SignalWithStartWorkflowExecutionResponse-
Returns#

void


SignalWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#signalWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?SignalWorkflowExecutionResponse-
Returns#

void


StartWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#startWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?StartWorkflowExecutionResponse-
Returns#

void


TerminateWorkflowExecutionCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#terminateWorkflowExecution}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?TerminateWorkflowExecutionResponse-
Returns#

void


UpdateNamespaceCallback#

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

Type declaration#

▸ (error, response?): void

Callback as used by {@link temporal.api.workflowservice.v1.WorkflowService#updateNamespace}.

Parameters#
NameTypeDescription
errorError | nullError, if any
response?UpdateNamespaceResponse-
Returns#

void