Class: WorkflowService
workflowservice.v1.WorkflowService
Represents a WorkflowService
Hierarchy
Service↳
WorkflowService
Constructors
constructor
• new WorkflowService(rpcImpl, requestDelimited?, responseDelimited?)
Constructs a new WorkflowService service.
Parameters
| Name | Type | Description |
|---|---|---|
rpcImpl | RPCImpl | RPC implementation |
requestDelimited? | boolean | Whether requests are length-delimited |
responseDelimited? | boolean | Whether responses are length-delimited |
Overrides
$protobuf.rpc.Service.constructor
Properties
requestDelimited
• requestDelimited: boolean
Whether requests are length-delimited.
Inherited from
$protobuf.rpc.Service.requestDelimited
responseDelimited
• responseDelimited: boolean
Whether responses are length-delimited.
Inherited from
$protobuf.rpc.Service.responseDelimited
rpcImpl
• rpcImpl: null | RPCImpl
RPC implementation. Becomes null once the service is ended.
Inherited from
$protobuf.rpc.Service.rpcImpl
Methods
countWorkflowExecutions
▸ countWorkflowExecutions(request, callback): void
Calls CountWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICountWorkflowExecutionsRequest | CountWorkflowExecutionsRequest message or plain object |
callback | CountWorkflowExecutionsCallback | Node-style callback called with the error, if any, and CountWorkflowExecutionsResponse |
Returns
void
▸ countWorkflowExecutions(request): Promise<CountWorkflowExecutionsResponse>
Calls CountWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICountWorkflowExecutionsRequest | CountWorkflowExecutionsRequest message or plain object |
Returns
Promise<CountWorkflowExecutionsResponse>
Promise
createSchedule
▸ createSchedule(request, callback): void
Calls CreateSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateScheduleRequest | CreateScheduleRequest message or plain object |
callback | CreateScheduleCallback | Node-style callback called with the error, if any, and CreateScheduleResponse |
Returns
void
▸ createSchedule(request): Promise<CreateScheduleResponse>
Calls CreateSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICreateScheduleRequest | CreateScheduleRequest message or plain object |
Returns
Promise<CreateScheduleResponse>
Promise
deleteSchedule
▸ deleteSchedule(request, callback): void
Calls DeleteSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteScheduleRequest | DeleteScheduleRequest message or plain object |
callback | DeleteScheduleCallback | Node-style callback called with the error, if any, and DeleteScheduleResponse |
Returns
void
▸ deleteSchedule(request): Promise<DeleteScheduleResponse>
Calls DeleteSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteScheduleRequest | DeleteScheduleRequest message or plain object |
Returns
Promise<DeleteScheduleResponse>
Promise
deprecateNamespace
▸ deprecateNamespace(request, callback): void
Calls DeprecateNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeprecateNamespaceRequest | DeprecateNamespaceRequest message or plain object |
callback | DeprecateNamespaceCallback | Node-style callback called with the error, if any, and DeprecateNamespaceResponse |
Returns
void
▸ deprecateNamespace(request): Promise<DeprecateNamespaceResponse>
Calls DeprecateNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeprecateNamespaceRequest | DeprecateNamespaceRequest message or plain object |
Returns
Promise<DeprecateNamespaceResponse>
Promise
describeNamespace
▸ describeNamespace(request, callback): void
Calls DescribeNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeNamespaceRequest | DescribeNamespaceRequest message or plain object |
callback | DescribeNamespaceCallback | Node-style callback called with the error, if any, and DescribeNamespaceResponse |
Returns
void
▸ describeNamespace(request): Promise<DescribeNamespaceResponse>
Calls DescribeNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeNamespaceRequest | DescribeNamespaceRequest message or plain object |
Returns
Promise<DescribeNamespaceResponse>
Promise
describeSchedule
▸ describeSchedule(request, callback): void
Calls DescribeSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeScheduleRequest | DescribeScheduleRequest message or plain object |
callback | DescribeScheduleCallback | Node-style callback called with the error, if any, and DescribeScheduleResponse |
Returns
void
▸ describeSchedule(request): Promise<DescribeScheduleResponse>
Calls DescribeSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeScheduleRequest | DescribeScheduleRequest message or plain object |
Returns
Promise<DescribeScheduleResponse>
Promise
describeTaskQueue
▸ describeTaskQueue(request, callback): void
Calls DescribeTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeTaskQueueRequest | DescribeTaskQueueRequest message or plain object |
callback | DescribeTaskQueueCallback | Node-style callback called with the error, if any, and DescribeTaskQueueResponse |
Returns
void
▸ describeTaskQueue(request): Promise<DescribeTaskQueueResponse>
Calls DescribeTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeTaskQueueRequest | DescribeTaskQueueRequest message or plain object |
Returns
Promise<DescribeTaskQueueResponse>
Promise
describeWorkflowExecution
▸ describeWorkflowExecution(request, callback): void
Calls DescribeWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeWorkflowExecutionRequest | DescribeWorkflowExecutionRequest message or plain object |
callback | DescribeWorkflowExecutionCallback | Node-style callback called with the error, if any, and DescribeWorkflowExecutionResponse |
Returns
void
▸ describeWorkflowExecution(request): Promise<DescribeWorkflowExecutionResponse>
Calls DescribeWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IDescribeWorkflowExecutionRequest | DescribeWorkflowExecutionRequest message or plain object |
Returns
Promise<DescribeWorkflowExecutionResponse>
Promise
emit
▸ emit(evt, ...args): WorkflowService
Emits an event by calling its listeners with the specified arguments.
Parameters
| Name | Type | Description |
|---|---|---|
evt | string | Event name |
...args | any[] | Arguments |
Returns
this
Inherited from
$protobuf.rpc.Service.emit
end
▸ end(endedByRPC?): Service
Ends this service and emits the end event.
Parameters
| Name | Type | Description |
|---|---|---|
endedByRPC? | boolean | Whether the service has been ended by the RPC implementation. |
Returns
Service
this
Inherited from
$protobuf.rpc.Service.end
getClusterInfo
▸ getClusterInfo(request, callback): void
Calls GetClusterInfo.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetClusterInfoRequest | GetClusterInfoRequest message or plain object |
callback | GetClusterInfoCallback | Node-style callback called with the error, if any, and GetClusterInfoResponse |
Returns
void
▸ getClusterInfo(request): Promise<GetClusterInfoResponse>
Calls GetClusterInfo.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetClusterInfoRequest | GetClusterInfoRequest message or plain object |
Returns
Promise<GetClusterInfoResponse>
Promise
getSearchAttributes
▸ getSearchAttributes(request, callback): void
Calls GetSearchAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetSearchAttributesRequest | GetSearchAttributesRequest message or plain object |
callback | GetSearchAttributesCallback | Node-style callback called with the error, if any, and GetSearchAttributesResponse |
Returns
void
▸ getSearchAttributes(request): Promise<GetSearchAttributesResponse>
Calls GetSearchAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetSearchAttributesRequest | GetSearchAttributesRequest message or plain object |
Returns
Promise<GetSearchAttributesResponse>
Promise
getSystemInfo
▸ getSystemInfo(request, callback): void
Calls GetSystemInfo.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetSystemInfoRequest | GetSystemInfoRequest message or plain object |
callback | GetSystemInfoCallback | Node-style callback called with the error, if any, and GetSystemInfoResponse |
Returns
void
▸ getSystemInfo(request): Promise<GetSystemInfoResponse>
Calls GetSystemInfo.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetSystemInfoRequest | GetSystemInfoRequest message or plain object |
Returns
Promise<GetSystemInfoResponse>
Promise
getWorkflowExecutionHistory
▸ getWorkflowExecutionHistory(request, callback): void
Calls GetWorkflowExecutionHistory.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetWorkflowExecutionHistoryRequest | GetWorkflowExecutionHistoryRequest message or plain object |
callback | GetWorkflowExecutionHistoryCallback | Node-style callback called with the error, if any, and GetWorkflowExecutionHistoryResponse |
Returns
void
▸ getWorkflowExecutionHistory(request): Promise<GetWorkflowExecutionHistoryResponse>
Calls GetWorkflowExecutionHistory.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetWorkflowExecutionHistoryRequest | GetWorkflowExecutionHistoryRequest message or plain object |
Returns
Promise<GetWorkflowExecutionHistoryResponse>
Promise
getWorkflowExecutionHistoryReverse
▸ getWorkflowExecutionHistoryReverse(request, callback): void
Calls GetWorkflowExecutionHistoryReverse.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetWorkflowExecutionHistoryReverseRequest | GetWorkflowExecutionHistoryReverseRequest message or plain object |
callback | GetWorkflowExecutionHistoryReverseCallback | Node-style callback called with the error, if any, and GetWorkflowExecutionHistoryReverseResponse |
Returns
void
▸ getWorkflowExecutionHistoryReverse(request): Promise<GetWorkflowExecutionHistoryReverseResponse>
Calls GetWorkflowExecutionHistoryReverse.
Parameters
| Name | Type | Description |
|---|---|---|
request | IGetWorkflowExecutionHistoryReverseRequest | GetWorkflowExecutionHistoryReverseRequest message or plain object |
Returns
Promise<GetWorkflowExecutionHistoryReverseResponse>
Promise
listArchivedWorkflowExecutions
▸ listArchivedWorkflowExecutions(request, callback): void
Calls ListArchivedWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListArchivedWorkflowExecutionsRequest | ListArchivedWorkflowExecutionsRequest message or plain object |
callback | ListArchivedWorkflowExecutionsCallback | Node-style callback called with the error, if any, and ListArchivedWorkflowExecutionsResponse |
Returns
void
▸ listArchivedWorkflowExecutions(request): Promise<ListArchivedWorkflowExecutionsResponse>
Calls ListArchivedWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListArchivedWorkflowExecutionsRequest | ListArchivedWorkflowExecutionsRequest message or plain object |
Returns
Promise<ListArchivedWorkflowExecutionsResponse>
Promise
listClosedWorkflowExecutions
▸ listClosedWorkflowExecutions(request, callback): void
Calls ListClosedWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListClosedWorkflowExecutionsRequest | ListClosedWorkflowExecutionsRequest message or plain object |
callback | ListClosedWorkflowExecutionsCallback | Node-style callback called with the error, if any, and ListClosedWorkflowExecutionsResponse |
Returns
void
▸ listClosedWorkflowExecutions(request): Promise<ListClosedWorkflowExecutionsResponse>
Calls ListClosedWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListClosedWorkflowExecutionsRequest | ListClosedWorkflowExecutionsRequest message or plain object |
Returns
Promise<ListClosedWorkflowExecutionsResponse>
Promise
listNamespaces
▸ listNamespaces(request, callback): void
Calls ListNamespaces.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListNamespacesRequest | ListNamespacesRequest message or plain object |
callback | ListNamespacesCallback | Node-style callback called with the error, if any, and ListNamespacesResponse |
Returns
void
▸ listNamespaces(request): Promise<ListNamespacesResponse>
Calls ListNamespaces.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListNamespacesRequest | ListNamespacesRequest message or plain object |
Returns
Promise<ListNamespacesResponse>
Promise
listOpenWorkflowExecutions
▸ listOpenWorkflowExecutions(request, callback): void
Calls ListOpenWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListOpenWorkflowExecutionsRequest | ListOpenWorkflowExecutionsRequest message or plain object |
callback | ListOpenWorkflowExecutionsCallback | Node-style callback called with the error, if any, and ListOpenWorkflowExecutionsResponse |
Returns
void
▸ listOpenWorkflowExecutions(request): Promise<ListOpenWorkflowExecutionsResponse>
Calls ListOpenWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListOpenWorkflowExecutionsRequest | ListOpenWorkflowExecutionsRequest message or plain object |
Returns
Promise<ListOpenWorkflowExecutionsResponse>
Promise
listScheduleMatchingTimes
▸ listScheduleMatchingTimes(request, callback): void
Calls ListScheduleMatchingTimes.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListScheduleMatchingTimesRequest | ListScheduleMatchingTimesRequest message or plain object |
callback | ListScheduleMatchingTimesCallback | Node-style callback called with the error, if any, and ListScheduleMatchingTimesResponse |
Returns
void
▸ listScheduleMatchingTimes(request): Promise<ListScheduleMatchingTimesResponse>
Calls ListScheduleMatchingTimes.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListScheduleMatchingTimesRequest | ListScheduleMatchingTimesRequest message or plain object |
Returns
Promise<ListScheduleMatchingTimesResponse>
Promise
listSchedules
▸ listSchedules(request, callback): void
Calls ListSchedules.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListSchedulesRequest | ListSchedulesRequest message or plain object |
callback | ListSchedulesCallback | Node-style callback called with the error, if any, and ListSchedulesResponse |
Returns
void
▸ listSchedules(request): Promise<ListSchedulesResponse>
Calls ListSchedules.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListSchedulesRequest | ListSchedulesRequest message or plain object |
Returns
Promise<ListSchedulesResponse>
Promise
listTaskQueuePartitions
▸ listTaskQueuePartitions(request, callback): void
Calls ListTaskQueuePartitions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListTaskQueuePartitionsRequest | ListTaskQueuePartitionsRequest message or plain object |
callback | ListTaskQueuePartitionsCallback | Node-style callback called with the error, if any, and ListTaskQueuePartitionsResponse |
Returns
void
▸ listTaskQueuePartitions(request): Promise<ListTaskQueuePartitionsResponse>
Calls ListTaskQueuePartitions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListTaskQueuePartitionsRequest | ListTaskQueuePartitionsRequest message or plain object |
Returns
Promise<ListTaskQueuePartitionsResponse>
Promise
listWorkflowExecutions
▸ listWorkflowExecutions(request, callback): void
Calls ListWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListWorkflowExecutionsRequest | ListWorkflowExecutionsRequest message or plain object |
callback | ListWorkflowExecutionsCallback | Node-style callback called with the error, if any, and ListWorkflowExecutionsResponse |
Returns
void
▸ listWorkflowExecutions(request): Promise<ListWorkflowExecutionsResponse>
Calls ListWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListWorkflowExecutionsRequest | ListWorkflowExecutionsRequest message or plain object |
Returns
Promise<ListWorkflowExecutionsResponse>
Promise
off
▸ off(evt?, fn?): WorkflowService
Removes an event listener or any matching listeners if arguments are omitted.
Parameters
| Name | Type | Description |
|---|---|---|
evt? | string | Event name. Removes all listeners if omitted. |
fn? | EventEmitterListener | Listener to remove. Removes all listeners of evt if omitted. |
Returns
this
Inherited from
$protobuf.rpc.Service.off
on
▸ on(evt, fn, ctx?): WorkflowService
Registers an event listener.
Parameters
| Name | Type | Description |
|---|---|---|
evt | string | Event name |
fn | EventEmitterListener | Listener |
ctx? | any | Listener context |
Returns
this
Inherited from
$protobuf.rpc.Service.on
patchSchedule
▸ patchSchedule(request, callback): void
Calls PatchSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IPatchScheduleRequest | PatchScheduleRequest message or plain object |
callback | PatchScheduleCallback | Node-style callback called with the error, if any, and PatchScheduleResponse |
Returns
void
▸ patchSchedule(request): Promise<PatchScheduleResponse>
Calls PatchSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IPatchScheduleRequest | PatchScheduleRequest message or plain object |
Returns
Promise<PatchScheduleResponse>
Promise
pollActivityTaskQueue
▸ pollActivityTaskQueue(request, callback): void
Calls PollActivityTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IPollActivityTaskQueueRequest | PollActivityTaskQueueRequest message or plain object |
callback | PollActivityTaskQueueCallback | Node-style callback called with the error, if any, and PollActivityTaskQueueResponse |
Returns
void
▸ pollActivityTaskQueue(request): Promise<PollActivityTaskQueueResponse>
Calls PollActivityTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IPollActivityTaskQueueRequest | PollActivityTaskQueueRequest message or plain object |
Returns
Promise<PollActivityTaskQueueResponse>
Promise
pollWorkflowTaskQueue
▸ pollWorkflowTaskQueue(request, callback): void
Calls PollWorkflowTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IPollWorkflowTaskQueueRequest | PollWorkflowTaskQueueRequest message or plain object |
callback | PollWorkflowTaskQueueCallback | Node-style callback called with the error, if any, and PollWorkflowTaskQueueResponse |
Returns
void
▸ pollWorkflowTaskQueue(request): Promise<PollWorkflowTaskQueueResponse>
Calls PollWorkflowTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IPollWorkflowTaskQueueRequest | PollWorkflowTaskQueueRequest message or plain object |
Returns
Promise<PollWorkflowTaskQueueResponse>
Promise
queryWorkflow
▸ queryWorkflow(request, callback): void
Calls QueryWorkflow.
Parameters
| Name | Type | Description |
|---|---|---|
request | IQueryWorkflowRequest | QueryWorkflowRequest message or plain object |
callback | QueryWorkflowCallback | Node-style callback called with the error, if any, and QueryWorkflowResponse |
Returns
void
▸ queryWorkflow(request): Promise<QueryWorkflowResponse>
Calls QueryWorkflow.
Parameters
| Name | Type | Description |
|---|---|---|
request | IQueryWorkflowRequest | QueryWorkflowRequest message or plain object |
Returns
Promise<QueryWorkflowResponse>
Promise
recordActivityTaskHeartbeat
▸ recordActivityTaskHeartbeat(request, callback): void
Calls RecordActivityTaskHeartbeat.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRecordActivityTaskHeartbeatRequest | RecordActivityTaskHeartbeatRequest message or plain object |
callback | RecordActivityTaskHeartbeatCallback | Node-style callback called with the error, if any, and RecordActivityTaskHeartbeatResponse |
Returns
void
▸ recordActivityTaskHeartbeat(request): Promise<RecordActivityTaskHeartbeatResponse>
Calls RecordActivityTaskHeartbeat.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRecordActivityTaskHeartbeatRequest | RecordActivityTaskHeartbeatRequest message or plain object |
Returns
Promise<RecordActivityTaskHeartbeatResponse>
Promise
recordActivityTaskHeartbeatById
▸ recordActivityTaskHeartbeatById(request, callback): void
Calls RecordActivityTaskHeartbeatById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRecordActivityTaskHeartbeatByIdRequest | RecordActivityTaskHeartbeatByIdRequest message or plain object |
callback | RecordActivityTaskHeartbeatByIdCallback | Node-style callback called with the error, if any, and RecordActivityTaskHeartbeatByIdResponse |
Returns
void
▸ recordActivityTaskHeartbeatById(request): Promise<RecordActivityTaskHeartbeatByIdResponse>
Calls RecordActivityTaskHeartbeatById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRecordActivityTaskHeartbeatByIdRequest | RecordActivityTaskHeartbeatByIdRequest message or plain object |
Returns
Promise<RecordActivityTaskHeartbeatByIdResponse>
Promise
registerNamespace
▸ registerNamespace(request, callback): void
Calls RegisterNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRegisterNamespaceRequest | RegisterNamespaceRequest message or plain object |
callback | RegisterNamespaceCallback | Node-style callback called with the error, if any, and RegisterNamespaceResponse |
Returns
void
▸ registerNamespace(request): Promise<RegisterNamespaceResponse>
Calls RegisterNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRegisterNamespaceRequest | RegisterNamespaceRequest message or plain object |
Returns
Promise<RegisterNamespaceResponse>
Promise
requestCancelWorkflowExecution
▸ requestCancelWorkflowExecution(request, callback): void
Calls RequestCancelWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRequestCancelWorkflowExecutionRequest | RequestCancelWorkflowExecutionRequest message or plain object |
callback | RequestCancelWorkflowExecutionCallback | Node-style callback called with the error, if any, and RequestCancelWorkflowExecutionResponse |
Returns
void
▸ requestCancelWorkflowExecution(request): Promise<RequestCancelWorkflowExecutionResponse>
Calls RequestCancelWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRequestCancelWorkflowExecutionRequest | RequestCancelWorkflowExecutionRequest message or plain object |
Returns
Promise<RequestCancelWorkflowExecutionResponse>
Promise
resetStickyTaskQueue
▸ resetStickyTaskQueue(request, callback): void
Calls ResetStickyTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IResetStickyTaskQueueRequest | ResetStickyTaskQueueRequest message or plain object |
callback | ResetStickyTaskQueueCallback | Node-style callback called with the error, if any, and ResetStickyTaskQueueResponse |
Returns
void
▸ resetStickyTaskQueue(request): Promise<ResetStickyTaskQueueResponse>
Calls ResetStickyTaskQueue.
Parameters
| Name | Type | Description |
|---|---|---|
request | IResetStickyTaskQueueRequest | ResetStickyTaskQueueRequest message or plain object |
Returns
Promise<ResetStickyTaskQueueResponse>
Promise
resetWorkflowExecution
▸ resetWorkflowExecution(request, callback): void
Calls ResetWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IResetWorkflowExecutionRequest | ResetWorkflowExecutionRequest message or plain object |
callback | ResetWorkflowExecutionCallback | Node-style callback called with the error, if any, and ResetWorkflowExecutionResponse |
Returns
void
▸ resetWorkflowExecution(request): Promise<ResetWorkflowExecutionResponse>
Calls ResetWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IResetWorkflowExecutionRequest | ResetWorkflowExecutionRequest message or plain object |
Returns
Promise<ResetWorkflowExecutionResponse>
Promise
respondActivityTaskCanceled
▸ respondActivityTaskCanceled(request, callback): void
Calls RespondActivityTaskCanceled.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCanceledRequest | RespondActivityTaskCanceledRequest message or plain object |
callback | RespondActivityTaskCanceledCallback | Node-style callback called with the error, if any, and RespondActivityTaskCanceledResponse |
Returns
void
▸ respondActivityTaskCanceled(request): Promise<RespondActivityTaskCanceledResponse>
Calls RespondActivityTaskCanceled.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCanceledRequest | RespondActivityTaskCanceledRequest message or plain object |
Returns
Promise<RespondActivityTaskCanceledResponse>
Promise
respondActivityTaskCanceledById
▸ respondActivityTaskCanceledById(request, callback): void
Calls RespondActivityTaskCanceledById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCanceledByIdRequest | RespondActivityTaskCanceledByIdRequest message or plain object |
callback | RespondActivityTaskCanceledByIdCallback | Node-style callback called with the error, if any, and RespondActivityTaskCanceledByIdResponse |
Returns
void
▸ respondActivityTaskCanceledById(request): Promise<RespondActivityTaskCanceledByIdResponse>
Calls RespondActivityTaskCanceledById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCanceledByIdRequest | RespondActivityTaskCanceledByIdRequest message or plain object |
Returns
Promise<RespondActivityTaskCanceledByIdResponse>
Promise
respondActivityTaskCompleted
▸ respondActivityTaskCompleted(request, callback): void
Calls RespondActivityTaskCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCompletedRequest | RespondActivityTaskCompletedRequest message or plain object |
callback | RespondActivityTaskCompletedCallback | Node-style callback called with the error, if any, and RespondActivityTaskCompletedResponse |
Returns
void
▸ respondActivityTaskCompleted(request): Promise<RespondActivityTaskCompletedResponse>
Calls RespondActivityTaskCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCompletedRequest | RespondActivityTaskCompletedRequest message or plain object |
Returns
Promise<RespondActivityTaskCompletedResponse>
Promise
respondActivityTaskCompletedById
▸ respondActivityTaskCompletedById(request, callback): void
Calls RespondActivityTaskCompletedById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCompletedByIdRequest | RespondActivityTaskCompletedByIdRequest message or plain object |
callback | RespondActivityTaskCompletedByIdCallback | Node-style callback called with the error, if any, and RespondActivityTaskCompletedByIdResponse |
Returns
void
▸ respondActivityTaskCompletedById(request): Promise<RespondActivityTaskCompletedByIdResponse>
Calls RespondActivityTaskCompletedById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskCompletedByIdRequest | RespondActivityTaskCompletedByIdRequest message or plain object |
Returns
Promise<RespondActivityTaskCompletedByIdResponse>
Promise
respondActivityTaskFailed
▸ respondActivityTaskFailed(request, callback): void
Calls RespondActivityTaskFailed.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskFailedRequest | RespondActivityTaskFailedRequest message or plain object |
callback | RespondActivityTaskFailedCallback | Node-style callback called with the error, if any, and RespondActivityTaskFailedResponse |
Returns
void
▸ respondActivityTaskFailed(request): Promise<RespondActivityTaskFailedResponse>
Calls RespondActivityTaskFailed.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskFailedRequest | RespondActivityTaskFailedRequest message or plain object |
Returns
Promise<RespondActivityTaskFailedResponse>
Promise
respondActivityTaskFailedById
▸ respondActivityTaskFailedById(request, callback): void
Calls RespondActivityTaskFailedById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskFailedByIdRequest | RespondActivityTaskFailedByIdRequest message or plain object |
callback | RespondActivityTaskFailedByIdCallback | Node-style callback called with the error, if any, and RespondActivityTaskFailedByIdResponse |
Returns
void
▸ respondActivityTaskFailedById(request): Promise<RespondActivityTaskFailedByIdResponse>
Calls RespondActivityTaskFailedById.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondActivityTaskFailedByIdRequest | RespondActivityTaskFailedByIdRequest message or plain object |
Returns
Promise<RespondActivityTaskFailedByIdResponse>
Promise
respondQueryTaskCompleted
▸ respondQueryTaskCompleted(request, callback): void
Calls RespondQueryTaskCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondQueryTaskCompletedRequest | RespondQueryTaskCompletedRequest message or plain object |
callback | RespondQueryTaskCompletedCallback | Node-style callback called with the error, if any, and RespondQueryTaskCompletedResponse |
Returns
void
▸ respondQueryTaskCompleted(request): Promise<RespondQueryTaskCompletedResponse>
Calls RespondQueryTaskCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondQueryTaskCompletedRequest | RespondQueryTaskCompletedRequest message or plain object |
Returns
Promise<RespondQueryTaskCompletedResponse>
Promise
respondWorkflowTaskCompleted
▸ respondWorkflowTaskCompleted(request, callback): void
Calls RespondWorkflowTaskCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondWorkflowTaskCompletedRequest | RespondWorkflowTaskCompletedRequest message or plain object |
callback | RespondWorkflowTaskCompletedCallback | Node-style callback called with the error, if any, and RespondWorkflowTaskCompletedResponse |
Returns
void
▸ respondWorkflowTaskCompleted(request): Promise<RespondWorkflowTaskCompletedResponse>
Calls RespondWorkflowTaskCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondWorkflowTaskCompletedRequest | RespondWorkflowTaskCompletedRequest message or plain object |
Returns
Promise<RespondWorkflowTaskCompletedResponse>
Promise
respondWorkflowTaskFailed
▸ respondWorkflowTaskFailed(request, callback): void
Calls RespondWorkflowTaskFailed.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondWorkflowTaskFailedRequest | RespondWorkflowTaskFailedRequest message or plain object |
callback | RespondWorkflowTaskFailedCallback | Node-style callback called with the error, if any, and RespondWorkflowTaskFailedResponse |
Returns
void
▸ respondWorkflowTaskFailed(request): Promise<RespondWorkflowTaskFailedResponse>
Calls RespondWorkflowTaskFailed.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRespondWorkflowTaskFailedRequest | RespondWorkflowTaskFailedRequest message or plain object |
Returns
Promise<RespondWorkflowTaskFailedResponse>
Promise
rpcCall
▸ rpcCall<TReq, TRes>(method, requestCtor, responseCtor, request, callback): void
Calls a service method through rpc.Service#rpcImpl|rpcImpl.
Type parameters
| Name | Type |
|---|---|
TReq | extends Message<TReq, TReq> |
TRes | extends Message<TRes, TRes> |
Parameters
| Name | Type | Description |
|---|---|---|
method | Method | ServiceMethod<TReq, TRes> | Reflected or static method |
requestCtor | Constructor<TReq> | Request constructor |
responseCtor | Constructor<TRes> | Response constructor |
request | TReq | Properties<TReq> | Request message or plain object |
callback | ServiceMethodCallback<TRes> | Service callback |
Returns
void
Inherited from
$protobuf.rpc.Service.rpcCall
scanWorkflowExecutions
▸ scanWorkflowExecutions(request, callback): void
Calls ScanWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IScanWorkflowExecutionsRequest | ScanWorkflowExecutionsRequest message or plain object |
callback | ScanWorkflowExecutionsCallback | Node-style callback called with the error, if any, and ScanWorkflowExecutionsResponse |
Returns
void
▸ scanWorkflowExecutions(request): Promise<ScanWorkflowExecutionsResponse>
Calls ScanWorkflowExecutions.
Parameters
| Name | Type | Description |
|---|---|---|
request | IScanWorkflowExecutionsRequest | ScanWorkflowExecutionsRequest message or plain object |
Returns
Promise<ScanWorkflowExecutionsResponse>
Promise
signalWithStartWorkflowExecution
▸ signalWithStartWorkflowExecution(request, callback): void
Calls SignalWithStartWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | ISignalWithStartWorkflowExecutionRequest | SignalWithStartWorkflowExecutionRequest message or plain object |
callback | SignalWithStartWorkflowExecutionCallback | Node-style callback called with the error, if any, and SignalWithStartWorkflowExecutionResponse |
Returns
void
▸ signalWithStartWorkflowExecution(request): Promise<SignalWithStartWorkflowExecutionResponse>
Calls SignalWithStartWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | ISignalWithStartWorkflowExecutionRequest | SignalWithStartWorkflowExecutionRequest message or plain object |
Returns
Promise<SignalWithStartWorkflowExecutionResponse>
Promise
signalWorkflowExecution
▸ signalWorkflowExecution(request, callback): void
Calls SignalWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | ISignalWorkflowExecutionRequest | SignalWorkflowExecutionRequest message or plain object |
callback | SignalWorkflowExecutionCallback | Node-style callback called with the error, if any, and SignalWorkflowExecutionResponse |
Returns
void
▸ signalWorkflowExecution(request): Promise<SignalWorkflowExecutionResponse>
Calls SignalWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | ISignalWorkflowExecutionRequest | SignalWorkflowExecutionRequest message or plain object |
Returns
Promise<SignalWorkflowExecutionResponse>
Promise
startWorkflowExecution
▸ startWorkflowExecution(request, callback): void
Calls StartWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IStartWorkflowExecutionRequest | StartWorkflowExecutionRequest message or plain object |
callback | StartWorkflowExecutionCallback | Node-style callback called with the error, if any, and StartWorkflowExecutionResponse |
Returns
void
▸ startWorkflowExecution(request): Promise<StartWorkflowExecutionResponse>
Calls StartWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | IStartWorkflowExecutionRequest | StartWorkflowExecutionRequest message or plain object |
Returns
Promise<StartWorkflowExecutionResponse>
Promise
terminateWorkflowExecution
▸ terminateWorkflowExecution(request, callback): void
Calls TerminateWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | ITerminateWorkflowExecutionRequest | TerminateWorkflowExecutionRequest message or plain object |
callback | TerminateWorkflowExecutionCallback | Node-style callback called with the error, if any, and TerminateWorkflowExecutionResponse |
Returns
void
▸ terminateWorkflowExecution(request): Promise<TerminateWorkflowExecutionResponse>
Calls TerminateWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
request | ITerminateWorkflowExecutionRequest | TerminateWorkflowExecutionRequest message or plain object |
Returns
Promise<TerminateWorkflowExecutionResponse>
Promise
updateNamespace
▸ updateNamespace(request, callback): void
Calls UpdateNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateNamespaceRequest | UpdateNamespaceRequest message or plain object |
callback | UpdateNamespaceCallback | Node-style callback called with the error, if any, and UpdateNamespaceResponse |
Returns
void
▸ updateNamespace(request): Promise<UpdateNamespaceResponse>
Calls UpdateNamespace.
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateNamespaceRequest | UpdateNamespaceRequest message or plain object |
Returns
Promise<UpdateNamespaceResponse>
Promise
updateSchedule
▸ updateSchedule(request, callback): void
Calls UpdateSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateScheduleRequest | UpdateScheduleRequest message or plain object |
callback | UpdateScheduleCallback | Node-style callback called with the error, if any, and UpdateScheduleResponse |
Returns
void
▸ updateSchedule(request): Promise<UpdateScheduleResponse>
Calls UpdateSchedule.
Parameters
| Name | Type | Description |
|---|---|---|
request | IUpdateScheduleRequest | UpdateScheduleRequest message or plain object |
Returns
Promise<UpdateScheduleResponse>
Promise
create
▸ Static create(rpcImpl, requestDelimited?, responseDelimited?): WorkflowService
Creates new WorkflowService service using the specified rpc implementation.
Parameters
| Name | Type | Description |
|---|---|---|
rpcImpl | RPCImpl | RPC implementation |
requestDelimited? | boolean | Whether requests are length-delimited |
responseDelimited? | boolean | Whether responses are length-delimited |
Returns
RPC service. Useful where requests and/or responses are streamed.