Skip to main content

Class: WorkflowService

workflowservice.v1.WorkflowService

Represents a WorkflowService

Hierarchy

  • Service

    WorkflowService

Constructors

constructor

new WorkflowService(rpcImpl, requestDelimited?, responseDelimited?)

Constructs a new WorkflowService service.

Parameters

NameTypeDescription
rpcImplRPCImplRPC implementation
requestDelimited?boolean-
responseDelimited?boolean-

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

NameTypeDescription
requestICountWorkflowExecutionsRequestCountWorkflowExecutionsRequest message or plain object
callbackCountWorkflowExecutionsCallbackNode-style callback called with the error, if any, and CountWorkflowExecutionsResponse

Returns

void

Promise

countWorkflowExecutions(request): Promise<CountWorkflowExecutionsResponse>

Calls CountWorkflowExecutions.

Parameters

NameTypeDescription
requestICountWorkflowExecutionsRequestCountWorkflowExecutionsRequest message or plain object

Returns

Promise<CountWorkflowExecutionsResponse>

Promise


createSchedule

createSchedule(request, callback): void

Calls CreateSchedule.

Parameters

NameTypeDescription
requestICreateScheduleRequestCreateScheduleRequest message or plain object
callbackCreateScheduleCallbackNode-style callback called with the error, if any, and CreateScheduleResponse

Returns

void

Promise

createSchedule(request): Promise<CreateScheduleResponse>

Calls CreateSchedule.

Parameters

NameTypeDescription
requestICreateScheduleRequestCreateScheduleRequest message or plain object

Returns

Promise<CreateScheduleResponse>

Promise


deleteSchedule

deleteSchedule(request, callback): void

Calls DeleteSchedule.

Parameters

NameTypeDescription
requestIDeleteScheduleRequestDeleteScheduleRequest message or plain object
callbackDeleteScheduleCallbackNode-style callback called with the error, if any, and DeleteScheduleResponse

Returns

void

Promise

deleteSchedule(request): Promise<DeleteScheduleResponse>

Calls DeleteSchedule.

Parameters

NameTypeDescription
requestIDeleteScheduleRequestDeleteScheduleRequest message or plain object

Returns

Promise<DeleteScheduleResponse>

Promise


deprecateNamespace

deprecateNamespace(request, callback): void

Calls DeprecateNamespace.

Parameters

NameTypeDescription
requestIDeprecateNamespaceRequestDeprecateNamespaceRequest message or plain object
callbackDeprecateNamespaceCallbackNode-style callback called with the error, if any, and DeprecateNamespaceResponse

Returns

void

Promise

deprecateNamespace(request): Promise<DeprecateNamespaceResponse>

Calls DeprecateNamespace.

Parameters

NameTypeDescription
requestIDeprecateNamespaceRequestDeprecateNamespaceRequest message or plain object

Returns

Promise<DeprecateNamespaceResponse>

Promise


describeNamespace

describeNamespace(request, callback): void

Calls DescribeNamespace.

Parameters

NameTypeDescription
requestIDescribeNamespaceRequestDescribeNamespaceRequest message or plain object
callbackDescribeNamespaceCallbackNode-style callback called with the error, if any, and DescribeNamespaceResponse

Returns

void

Promise

describeNamespace(request): Promise<DescribeNamespaceResponse>

Calls DescribeNamespace.

Parameters

NameTypeDescription
requestIDescribeNamespaceRequestDescribeNamespaceRequest message or plain object

Returns

Promise<DescribeNamespaceResponse>

Promise


describeSchedule

describeSchedule(request, callback): void

Calls DescribeSchedule.

Parameters

NameTypeDescription
requestIDescribeScheduleRequestDescribeScheduleRequest message or plain object
callbackDescribeScheduleCallbackNode-style callback called with the error, if any, and DescribeScheduleResponse

Returns

void

Promise

describeSchedule(request): Promise<DescribeScheduleResponse>

Calls DescribeSchedule.

Parameters

NameTypeDescription
requestIDescribeScheduleRequestDescribeScheduleRequest message or plain object

Returns

Promise<DescribeScheduleResponse>

Promise


describeTaskQueue

describeTaskQueue(request, callback): void

Calls DescribeTaskQueue.

Parameters

NameTypeDescription
requestIDescribeTaskQueueRequestDescribeTaskQueueRequest message or plain object
callbackDescribeTaskQueueCallbackNode-style callback called with the error, if any, and DescribeTaskQueueResponse

Returns

void

Promise

describeTaskQueue(request): Promise<DescribeTaskQueueResponse>

Calls DescribeTaskQueue.

Parameters

NameTypeDescription
requestIDescribeTaskQueueRequestDescribeTaskQueueRequest message or plain object

Returns

Promise<DescribeTaskQueueResponse>

Promise


describeWorkflowExecution

describeWorkflowExecution(request, callback): void

Calls DescribeWorkflowExecution.

Parameters

NameTypeDescription
requestIDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest message or plain object
callbackDescribeWorkflowExecutionCallbackNode-style callback called with the error, if any, and DescribeWorkflowExecutionResponse

Returns

void

Promise

describeWorkflowExecution(request): Promise<DescribeWorkflowExecutionResponse>

Calls DescribeWorkflowExecution.

Parameters

NameTypeDescription
requestIDescribeWorkflowExecutionRequestDescribeWorkflowExecutionRequest 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

NameTypeDescription
evtstringEvent name
...argsany[]Arguments

Returns

WorkflowService

this

Inherited from

$protobuf.rpc.Service.emit


end

end(endedByRPC?): Service

Ends this service and emits the end event.

Parameters

NameType
endedByRPC?boolean

Returns

Service

this

Inherited from

$protobuf.rpc.Service.end


getClusterInfo

getClusterInfo(request, callback): void

Calls GetClusterInfo.

Parameters

NameTypeDescription
requestIGetClusterInfoRequestGetClusterInfoRequest message or plain object
callbackGetClusterInfoCallbackNode-style callback called with the error, if any, and GetClusterInfoResponse

Returns

void

Promise

getClusterInfo(request): Promise<GetClusterInfoResponse>

Calls GetClusterInfo.

Parameters

NameTypeDescription
requestIGetClusterInfoRequestGetClusterInfoRequest message or plain object

Returns

Promise<GetClusterInfoResponse>

Promise


getSearchAttributes

getSearchAttributes(request, callback): void

Calls GetSearchAttributes.

Parameters

NameTypeDescription
requestIGetSearchAttributesRequestGetSearchAttributesRequest message or plain object
callbackGetSearchAttributesCallbackNode-style callback called with the error, if any, and GetSearchAttributesResponse

Returns

void

Promise

getSearchAttributes(request): Promise<GetSearchAttributesResponse>

Calls GetSearchAttributes.

Parameters

NameTypeDescription
requestIGetSearchAttributesRequestGetSearchAttributesRequest message or plain object

Returns

Promise<GetSearchAttributesResponse>

Promise


getSystemInfo

getSystemInfo(request, callback): void

Calls GetSystemInfo.

Parameters

NameTypeDescription
requestIGetSystemInfoRequestGetSystemInfoRequest message or plain object
callbackGetSystemInfoCallbackNode-style callback called with the error, if any, and GetSystemInfoResponse

Returns

void

Promise

getSystemInfo(request): Promise<GetSystemInfoResponse>

Calls GetSystemInfo.

Parameters

NameTypeDescription
requestIGetSystemInfoRequestGetSystemInfoRequest message or plain object

Returns

Promise<GetSystemInfoResponse>

Promise


getWorkflowExecutionHistory

getWorkflowExecutionHistory(request, callback): void

Calls GetWorkflowExecutionHistory.

Parameters

NameTypeDescription
requestIGetWorkflowExecutionHistoryRequestGetWorkflowExecutionHistoryRequest message or plain object
callbackGetWorkflowExecutionHistoryCallbackNode-style callback called with the error, if any, and GetWorkflowExecutionHistoryResponse

Returns

void

Promise

getWorkflowExecutionHistory(request): Promise<GetWorkflowExecutionHistoryResponse>

Calls GetWorkflowExecutionHistory.

Parameters

NameTypeDescription
requestIGetWorkflowExecutionHistoryRequestGetWorkflowExecutionHistoryRequest message or plain object

Returns

Promise<GetWorkflowExecutionHistoryResponse>

Promise


getWorkflowExecutionHistoryReverse

getWorkflowExecutionHistoryReverse(request, callback): void

Calls GetWorkflowExecutionHistoryReverse.

Parameters

NameTypeDescription
requestIGetWorkflowExecutionHistoryReverseRequestGetWorkflowExecutionHistoryReverseRequest message or plain object
callbackGetWorkflowExecutionHistoryReverseCallbackNode-style callback called with the error, if any, and GetWorkflowExecutionHistoryReverseResponse

Returns

void

Promise

getWorkflowExecutionHistoryReverse(request): Promise<GetWorkflowExecutionHistoryReverseResponse>

Calls GetWorkflowExecutionHistoryReverse.

Parameters

NameTypeDescription
requestIGetWorkflowExecutionHistoryReverseRequestGetWorkflowExecutionHistoryReverseRequest message or plain object

Returns

Promise<GetWorkflowExecutionHistoryReverseResponse>

Promise


listArchivedWorkflowExecutions

listArchivedWorkflowExecutions(request, callback): void

Calls ListArchivedWorkflowExecutions.

Parameters

NameTypeDescription
requestIListArchivedWorkflowExecutionsRequestListArchivedWorkflowExecutionsRequest message or plain object
callbackListArchivedWorkflowExecutionsCallbackNode-style callback called with the error, if any, and ListArchivedWorkflowExecutionsResponse

Returns

void

Promise

listArchivedWorkflowExecutions(request): Promise<ListArchivedWorkflowExecutionsResponse>

Calls ListArchivedWorkflowExecutions.

Parameters

NameTypeDescription
requestIListArchivedWorkflowExecutionsRequestListArchivedWorkflowExecutionsRequest message or plain object

Returns

Promise<ListArchivedWorkflowExecutionsResponse>

Promise


listClosedWorkflowExecutions

listClosedWorkflowExecutions(request, callback): void

Calls ListClosedWorkflowExecutions.

Parameters

NameTypeDescription
requestIListClosedWorkflowExecutionsRequestListClosedWorkflowExecutionsRequest message or plain object
callbackListClosedWorkflowExecutionsCallbackNode-style callback called with the error, if any, and ListClosedWorkflowExecutionsResponse

Returns

void

Promise

listClosedWorkflowExecutions(request): Promise<ListClosedWorkflowExecutionsResponse>

Calls ListClosedWorkflowExecutions.

Parameters

NameTypeDescription
requestIListClosedWorkflowExecutionsRequestListClosedWorkflowExecutionsRequest message or plain object

Returns

Promise<ListClosedWorkflowExecutionsResponse>

Promise


listNamespaces

listNamespaces(request, callback): void

Calls ListNamespaces.

Parameters

NameTypeDescription
requestIListNamespacesRequestListNamespacesRequest message or plain object
callbackListNamespacesCallbackNode-style callback called with the error, if any, and ListNamespacesResponse

Returns

void

Promise

listNamespaces(request): Promise<ListNamespacesResponse>

Calls ListNamespaces.

Parameters

NameTypeDescription
requestIListNamespacesRequestListNamespacesRequest message or plain object

Returns

Promise<ListNamespacesResponse>

Promise


listOpenWorkflowExecutions

listOpenWorkflowExecutions(request, callback): void

Calls ListOpenWorkflowExecutions.

Parameters

NameTypeDescription
requestIListOpenWorkflowExecutionsRequestListOpenWorkflowExecutionsRequest message or plain object
callbackListOpenWorkflowExecutionsCallbackNode-style callback called with the error, if any, and ListOpenWorkflowExecutionsResponse

Returns

void

Promise

listOpenWorkflowExecutions(request): Promise<ListOpenWorkflowExecutionsResponse>

Calls ListOpenWorkflowExecutions.

Parameters

NameTypeDescription
requestIListOpenWorkflowExecutionsRequestListOpenWorkflowExecutionsRequest message or plain object

Returns

Promise<ListOpenWorkflowExecutionsResponse>

Promise


listScheduleMatchingTimes

listScheduleMatchingTimes(request, callback): void

Calls ListScheduleMatchingTimes.

Parameters

NameTypeDescription
requestIListScheduleMatchingTimesRequestListScheduleMatchingTimesRequest message or plain object
callbackListScheduleMatchingTimesCallbackNode-style callback called with the error, if any, and ListScheduleMatchingTimesResponse

Returns

void

Promise

listScheduleMatchingTimes(request): Promise<ListScheduleMatchingTimesResponse>

Calls ListScheduleMatchingTimes.

Parameters

NameTypeDescription
requestIListScheduleMatchingTimesRequestListScheduleMatchingTimesRequest message or plain object

Returns

Promise<ListScheduleMatchingTimesResponse>

Promise


listSchedules

listSchedules(request, callback): void

Calls ListSchedules.

Parameters

NameTypeDescription
requestIListSchedulesRequestListSchedulesRequest message or plain object
callbackListSchedulesCallbackNode-style callback called with the error, if any, and ListSchedulesResponse

Returns

void

Promise

listSchedules(request): Promise<ListSchedulesResponse>

Calls ListSchedules.

Parameters

NameTypeDescription
requestIListSchedulesRequestListSchedulesRequest message or plain object

Returns

Promise<ListSchedulesResponse>

Promise


listTaskQueuePartitions

listTaskQueuePartitions(request, callback): void

Calls ListTaskQueuePartitions.

Parameters

NameTypeDescription
requestIListTaskQueuePartitionsRequestListTaskQueuePartitionsRequest message or plain object
callbackListTaskQueuePartitionsCallbackNode-style callback called with the error, if any, and ListTaskQueuePartitionsResponse

Returns

void

Promise

listTaskQueuePartitions(request): Promise<ListTaskQueuePartitionsResponse>

Calls ListTaskQueuePartitions.

Parameters

NameTypeDescription
requestIListTaskQueuePartitionsRequestListTaskQueuePartitionsRequest message or plain object

Returns

Promise<ListTaskQueuePartitionsResponse>

Promise


listWorkflowExecutions

listWorkflowExecutions(request, callback): void

Calls ListWorkflowExecutions.

Parameters

NameTypeDescription
requestIListWorkflowExecutionsRequestListWorkflowExecutionsRequest message or plain object
callbackListWorkflowExecutionsCallbackNode-style callback called with the error, if any, and ListWorkflowExecutionsResponse

Returns

void

Promise

listWorkflowExecutions(request): Promise<ListWorkflowExecutionsResponse>

Calls ListWorkflowExecutions.

Parameters

NameTypeDescription
requestIListWorkflowExecutionsRequestListWorkflowExecutionsRequest 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

NameType
evt?string
fn?EventEmitterListener

Returns

WorkflowService

this

Inherited from

$protobuf.rpc.Service.off


on

on(evt, fn, ctx?): WorkflowService

Registers an event listener.

Parameters

NameTypeDescription
evtstringEvent name
fnEventEmitterListenerListener
ctx?any-

Returns

WorkflowService

this

Inherited from

$protobuf.rpc.Service.on


patchSchedule

patchSchedule(request, callback): void

Calls PatchSchedule.

Parameters

NameTypeDescription
requestIPatchScheduleRequestPatchScheduleRequest message or plain object
callbackPatchScheduleCallbackNode-style callback called with the error, if any, and PatchScheduleResponse

Returns

void

Promise

patchSchedule(request): Promise<PatchScheduleResponse>

Calls PatchSchedule.

Parameters

NameTypeDescription
requestIPatchScheduleRequestPatchScheduleRequest message or plain object

Returns

Promise<PatchScheduleResponse>

Promise


pollActivityTaskQueue

pollActivityTaskQueue(request, callback): void

Calls PollActivityTaskQueue.

Parameters

NameTypeDescription
requestIPollActivityTaskQueueRequestPollActivityTaskQueueRequest message or plain object
callbackPollActivityTaskQueueCallbackNode-style callback called with the error, if any, and PollActivityTaskQueueResponse

Returns

void

Promise

pollActivityTaskQueue(request): Promise<PollActivityTaskQueueResponse>

Calls PollActivityTaskQueue.

Parameters

NameTypeDescription
requestIPollActivityTaskQueueRequestPollActivityTaskQueueRequest message or plain object

Returns

Promise<PollActivityTaskQueueResponse>

Promise


pollWorkflowTaskQueue

pollWorkflowTaskQueue(request, callback): void

Calls PollWorkflowTaskQueue.

Parameters

NameTypeDescription
requestIPollWorkflowTaskQueueRequestPollWorkflowTaskQueueRequest message or plain object
callbackPollWorkflowTaskQueueCallbackNode-style callback called with the error, if any, and PollWorkflowTaskQueueResponse

Returns

void

Promise

pollWorkflowTaskQueue(request): Promise<PollWorkflowTaskQueueResponse>

Calls PollWorkflowTaskQueue.

Parameters

NameTypeDescription
requestIPollWorkflowTaskQueueRequestPollWorkflowTaskQueueRequest message or plain object

Returns

Promise<PollWorkflowTaskQueueResponse>

Promise


queryWorkflow

queryWorkflow(request, callback): void

Calls QueryWorkflow.

Parameters

NameTypeDescription
requestIQueryWorkflowRequestQueryWorkflowRequest message or plain object
callbackQueryWorkflowCallbackNode-style callback called with the error, if any, and QueryWorkflowResponse

Returns

void

Promise

queryWorkflow(request): Promise<QueryWorkflowResponse>

Calls QueryWorkflow.

Parameters

NameTypeDescription
requestIQueryWorkflowRequestQueryWorkflowRequest message or plain object

Returns

Promise<QueryWorkflowResponse>

Promise


recordActivityTaskHeartbeat

recordActivityTaskHeartbeat(request, callback): void

Calls RecordActivityTaskHeartbeat.

Parameters

NameTypeDescription
requestIRecordActivityTaskHeartbeatRequestRecordActivityTaskHeartbeatRequest message or plain object
callbackRecordActivityTaskHeartbeatCallbackNode-style callback called with the error, if any, and RecordActivityTaskHeartbeatResponse

Returns

void

Promise

recordActivityTaskHeartbeat(request): Promise<RecordActivityTaskHeartbeatResponse>

Calls RecordActivityTaskHeartbeat.

Parameters

NameTypeDescription
requestIRecordActivityTaskHeartbeatRequestRecordActivityTaskHeartbeatRequest message or plain object

Returns

Promise<RecordActivityTaskHeartbeatResponse>

Promise


recordActivityTaskHeartbeatById

recordActivityTaskHeartbeatById(request, callback): void

Calls RecordActivityTaskHeartbeatById.

Parameters

NameTypeDescription
requestIRecordActivityTaskHeartbeatByIdRequestRecordActivityTaskHeartbeatByIdRequest message or plain object
callbackRecordActivityTaskHeartbeatByIdCallbackNode-style callback called with the error, if any, and RecordActivityTaskHeartbeatByIdResponse

Returns

void

Promise

recordActivityTaskHeartbeatById(request): Promise<RecordActivityTaskHeartbeatByIdResponse>

Calls RecordActivityTaskHeartbeatById.

Parameters

NameTypeDescription
requestIRecordActivityTaskHeartbeatByIdRequestRecordActivityTaskHeartbeatByIdRequest message or plain object

Returns

Promise<RecordActivityTaskHeartbeatByIdResponse>

Promise


registerNamespace

registerNamespace(request, callback): void

Calls RegisterNamespace.

Parameters

NameTypeDescription
requestIRegisterNamespaceRequestRegisterNamespaceRequest message or plain object
callbackRegisterNamespaceCallbackNode-style callback called with the error, if any, and RegisterNamespaceResponse

Returns

void

Promise

registerNamespace(request): Promise<RegisterNamespaceResponse>

Calls RegisterNamespace.

Parameters

NameTypeDescription
requestIRegisterNamespaceRequestRegisterNamespaceRequest message or plain object

Returns

Promise<RegisterNamespaceResponse>

Promise


requestCancelWorkflowExecution

requestCancelWorkflowExecution(request, callback): void

Calls RequestCancelWorkflowExecution.

Parameters

NameTypeDescription
requestIRequestCancelWorkflowExecutionRequestRequestCancelWorkflowExecutionRequest message or plain object
callbackRequestCancelWorkflowExecutionCallbackNode-style callback called with the error, if any, and RequestCancelWorkflowExecutionResponse

Returns

void

Promise

requestCancelWorkflowExecution(request): Promise<RequestCancelWorkflowExecutionResponse>

Calls RequestCancelWorkflowExecution.

Parameters

NameTypeDescription
requestIRequestCancelWorkflowExecutionRequestRequestCancelWorkflowExecutionRequest message or plain object

Returns

Promise<RequestCancelWorkflowExecutionResponse>

Promise


resetStickyTaskQueue

resetStickyTaskQueue(request, callback): void

Calls ResetStickyTaskQueue.

Parameters

NameTypeDescription
requestIResetStickyTaskQueueRequestResetStickyTaskQueueRequest message or plain object
callbackResetStickyTaskQueueCallbackNode-style callback called with the error, if any, and ResetStickyTaskQueueResponse

Returns

void

Promise

resetStickyTaskQueue(request): Promise<ResetStickyTaskQueueResponse>

Calls ResetStickyTaskQueue.

Parameters

NameTypeDescription
requestIResetStickyTaskQueueRequestResetStickyTaskQueueRequest message or plain object

Returns

Promise<ResetStickyTaskQueueResponse>

Promise


resetWorkflowExecution

resetWorkflowExecution(request, callback): void

Calls ResetWorkflowExecution.

Parameters

NameTypeDescription
requestIResetWorkflowExecutionRequestResetWorkflowExecutionRequest message or plain object
callbackResetWorkflowExecutionCallbackNode-style callback called with the error, if any, and ResetWorkflowExecutionResponse

Returns

void

Promise

resetWorkflowExecution(request): Promise<ResetWorkflowExecutionResponse>

Calls ResetWorkflowExecution.

Parameters

NameTypeDescription
requestIResetWorkflowExecutionRequestResetWorkflowExecutionRequest message or plain object

Returns

Promise<ResetWorkflowExecutionResponse>

Promise


respondActivityTaskCanceled

respondActivityTaskCanceled(request, callback): void

Calls RespondActivityTaskCanceled.

Parameters

NameTypeDescription
requestIRespondActivityTaskCanceledRequestRespondActivityTaskCanceledRequest message or plain object
callbackRespondActivityTaskCanceledCallbackNode-style callback called with the error, if any, and RespondActivityTaskCanceledResponse

Returns

void

Promise

respondActivityTaskCanceled(request): Promise<RespondActivityTaskCanceledResponse>

Calls RespondActivityTaskCanceled.

Parameters

NameTypeDescription
requestIRespondActivityTaskCanceledRequestRespondActivityTaskCanceledRequest message or plain object

Returns

Promise<RespondActivityTaskCanceledResponse>

Promise


respondActivityTaskCanceledById

respondActivityTaskCanceledById(request, callback): void

Calls RespondActivityTaskCanceledById.

Parameters

NameTypeDescription
requestIRespondActivityTaskCanceledByIdRequestRespondActivityTaskCanceledByIdRequest message or plain object
callbackRespondActivityTaskCanceledByIdCallbackNode-style callback called with the error, if any, and RespondActivityTaskCanceledByIdResponse

Returns

void

Promise

respondActivityTaskCanceledById(request): Promise<RespondActivityTaskCanceledByIdResponse>

Calls RespondActivityTaskCanceledById.

Parameters

NameTypeDescription
requestIRespondActivityTaskCanceledByIdRequestRespondActivityTaskCanceledByIdRequest message or plain object

Returns

Promise<RespondActivityTaskCanceledByIdResponse>

Promise


respondActivityTaskCompleted

respondActivityTaskCompleted(request, callback): void

Calls RespondActivityTaskCompleted.

Parameters

NameTypeDescription
requestIRespondActivityTaskCompletedRequestRespondActivityTaskCompletedRequest message or plain object
callbackRespondActivityTaskCompletedCallbackNode-style callback called with the error, if any, and RespondActivityTaskCompletedResponse

Returns

void

Promise

respondActivityTaskCompleted(request): Promise<RespondActivityTaskCompletedResponse>

Calls RespondActivityTaskCompleted.

Parameters

NameTypeDescription
requestIRespondActivityTaskCompletedRequestRespondActivityTaskCompletedRequest message or plain object

Returns

Promise<RespondActivityTaskCompletedResponse>

Promise


respondActivityTaskCompletedById

respondActivityTaskCompletedById(request, callback): void

Calls RespondActivityTaskCompletedById.

Parameters

NameTypeDescription
requestIRespondActivityTaskCompletedByIdRequestRespondActivityTaskCompletedByIdRequest message or plain object
callbackRespondActivityTaskCompletedByIdCallbackNode-style callback called with the error, if any, and RespondActivityTaskCompletedByIdResponse

Returns

void

Promise

respondActivityTaskCompletedById(request): Promise<RespondActivityTaskCompletedByIdResponse>

Calls RespondActivityTaskCompletedById.

Parameters

NameTypeDescription
requestIRespondActivityTaskCompletedByIdRequestRespondActivityTaskCompletedByIdRequest message or plain object

Returns

Promise<RespondActivityTaskCompletedByIdResponse>

Promise


respondActivityTaskFailed

respondActivityTaskFailed(request, callback): void

Calls RespondActivityTaskFailed.

Parameters

NameTypeDescription
requestIRespondActivityTaskFailedRequestRespondActivityTaskFailedRequest message or plain object
callbackRespondActivityTaskFailedCallbackNode-style callback called with the error, if any, and RespondActivityTaskFailedResponse

Returns

void

Promise

respondActivityTaskFailed(request): Promise<RespondActivityTaskFailedResponse>

Calls RespondActivityTaskFailed.

Parameters

NameTypeDescription
requestIRespondActivityTaskFailedRequestRespondActivityTaskFailedRequest message or plain object

Returns

Promise<RespondActivityTaskFailedResponse>

Promise


respondActivityTaskFailedById

respondActivityTaskFailedById(request, callback): void

Calls RespondActivityTaskFailedById.

Parameters

NameTypeDescription
requestIRespondActivityTaskFailedByIdRequestRespondActivityTaskFailedByIdRequest message or plain object
callbackRespondActivityTaskFailedByIdCallbackNode-style callback called with the error, if any, and RespondActivityTaskFailedByIdResponse

Returns

void

Promise

respondActivityTaskFailedById(request): Promise<RespondActivityTaskFailedByIdResponse>

Calls RespondActivityTaskFailedById.

Parameters

NameTypeDescription
requestIRespondActivityTaskFailedByIdRequestRespondActivityTaskFailedByIdRequest message or plain object

Returns

Promise<RespondActivityTaskFailedByIdResponse>

Promise


respondQueryTaskCompleted

respondQueryTaskCompleted(request, callback): void

Calls RespondQueryTaskCompleted.

Parameters

NameTypeDescription
requestIRespondQueryTaskCompletedRequestRespondQueryTaskCompletedRequest message or plain object
callbackRespondQueryTaskCompletedCallbackNode-style callback called with the error, if any, and RespondQueryTaskCompletedResponse

Returns

void

Promise

respondQueryTaskCompleted(request): Promise<RespondQueryTaskCompletedResponse>

Calls RespondQueryTaskCompleted.

Parameters

NameTypeDescription
requestIRespondQueryTaskCompletedRequestRespondQueryTaskCompletedRequest message or plain object

Returns

Promise<RespondQueryTaskCompletedResponse>

Promise


respondWorkflowTaskCompleted

respondWorkflowTaskCompleted(request, callback): void

Calls RespondWorkflowTaskCompleted.

Parameters

NameTypeDescription
requestIRespondWorkflowTaskCompletedRequestRespondWorkflowTaskCompletedRequest message or plain object
callbackRespondWorkflowTaskCompletedCallbackNode-style callback called with the error, if any, and RespondWorkflowTaskCompletedResponse

Returns

void

Promise

respondWorkflowTaskCompleted(request): Promise<RespondWorkflowTaskCompletedResponse>

Calls RespondWorkflowTaskCompleted.

Parameters

NameTypeDescription
requestIRespondWorkflowTaskCompletedRequestRespondWorkflowTaskCompletedRequest message or plain object

Returns

Promise<RespondWorkflowTaskCompletedResponse>

Promise


respondWorkflowTaskFailed

respondWorkflowTaskFailed(request, callback): void

Calls RespondWorkflowTaskFailed.

Parameters

NameTypeDescription
requestIRespondWorkflowTaskFailedRequestRespondWorkflowTaskFailedRequest message or plain object
callbackRespondWorkflowTaskFailedCallbackNode-style callback called with the error, if any, and RespondWorkflowTaskFailedResponse

Returns

void

Promise

respondWorkflowTaskFailed(request): Promise<RespondWorkflowTaskFailedResponse>

Calls RespondWorkflowTaskFailed.

Parameters

NameTypeDescription
requestIRespondWorkflowTaskFailedRequestRespondWorkflowTaskFailedRequest message or plain object

Returns

Promise<RespondWorkflowTaskFailedResponse>

Promise


rpcCall

rpcCall<TReq, TRes>(method, requestCtor, responseCtor, request, callback): void

Calls a service method through {@link rpc.Service#rpcImpl|rpcImpl}.

Type parameters

NameType
TReqextends Message<TReq, TReq>
TResextends Message<TRes, TRes>

Parameters

NameTypeDescription
methodMethod | ServiceMethod<TReq, TRes>Reflected or static method
requestCtorConstructor<TReq>Request constructor
responseCtorConstructor<TRes>Response constructor
requestTReq | Properties<TReq>Request message or plain object
callbackServiceMethodCallback<TRes>Service callback

Returns

void

Inherited from

$protobuf.rpc.Service.rpcCall


scanWorkflowExecutions

scanWorkflowExecutions(request, callback): void

Calls ScanWorkflowExecutions.

Parameters

NameTypeDescription
requestIScanWorkflowExecutionsRequestScanWorkflowExecutionsRequest message or plain object
callbackScanWorkflowExecutionsCallbackNode-style callback called with the error, if any, and ScanWorkflowExecutionsResponse

Returns

void

Promise

scanWorkflowExecutions(request): Promise<ScanWorkflowExecutionsResponse>

Calls ScanWorkflowExecutions.

Parameters

NameTypeDescription
requestIScanWorkflowExecutionsRequestScanWorkflowExecutionsRequest message or plain object

Returns

Promise<ScanWorkflowExecutionsResponse>

Promise


signalWithStartWorkflowExecution

signalWithStartWorkflowExecution(request, callback): void

Calls SignalWithStartWorkflowExecution.

Parameters

NameTypeDescription
requestISignalWithStartWorkflowExecutionRequestSignalWithStartWorkflowExecutionRequest message or plain object
callbackSignalWithStartWorkflowExecutionCallbackNode-style callback called with the error, if any, and SignalWithStartWorkflowExecutionResponse

Returns

void

Promise

signalWithStartWorkflowExecution(request): Promise<SignalWithStartWorkflowExecutionResponse>

Calls SignalWithStartWorkflowExecution.

Parameters

NameTypeDescription
requestISignalWithStartWorkflowExecutionRequestSignalWithStartWorkflowExecutionRequest message or plain object

Returns

Promise<SignalWithStartWorkflowExecutionResponse>

Promise


signalWorkflowExecution

signalWorkflowExecution(request, callback): void

Calls SignalWorkflowExecution.

Parameters

NameTypeDescription
requestISignalWorkflowExecutionRequestSignalWorkflowExecutionRequest message or plain object
callbackSignalWorkflowExecutionCallbackNode-style callback called with the error, if any, and SignalWorkflowExecutionResponse

Returns

void

Promise

signalWorkflowExecution(request): Promise<SignalWorkflowExecutionResponse>

Calls SignalWorkflowExecution.

Parameters

NameTypeDescription
requestISignalWorkflowExecutionRequestSignalWorkflowExecutionRequest message or plain object

Returns

Promise<SignalWorkflowExecutionResponse>

Promise


startWorkflowExecution

startWorkflowExecution(request, callback): void

Calls StartWorkflowExecution.

Parameters

NameTypeDescription
requestIStartWorkflowExecutionRequestStartWorkflowExecutionRequest message or plain object
callbackStartWorkflowExecutionCallbackNode-style callback called with the error, if any, and StartWorkflowExecutionResponse

Returns

void

Promise

startWorkflowExecution(request): Promise<StartWorkflowExecutionResponse>

Calls StartWorkflowExecution.

Parameters

NameTypeDescription
requestIStartWorkflowExecutionRequestStartWorkflowExecutionRequest message or plain object

Returns

Promise<StartWorkflowExecutionResponse>

Promise


terminateWorkflowExecution

terminateWorkflowExecution(request, callback): void

Calls TerminateWorkflowExecution.

Parameters

NameTypeDescription
requestITerminateWorkflowExecutionRequestTerminateWorkflowExecutionRequest message or plain object
callbackTerminateWorkflowExecutionCallbackNode-style callback called with the error, if any, and TerminateWorkflowExecutionResponse

Returns

void

Promise

terminateWorkflowExecution(request): Promise<TerminateWorkflowExecutionResponse>

Calls TerminateWorkflowExecution.

Parameters

NameTypeDescription
requestITerminateWorkflowExecutionRequestTerminateWorkflowExecutionRequest message or plain object

Returns

Promise<TerminateWorkflowExecutionResponse>

Promise


updateNamespace

updateNamespace(request, callback): void

Calls UpdateNamespace.

Parameters

NameTypeDescription
requestIUpdateNamespaceRequestUpdateNamespaceRequest message or plain object
callbackUpdateNamespaceCallbackNode-style callback called with the error, if any, and UpdateNamespaceResponse

Returns

void

Promise

updateNamespace(request): Promise<UpdateNamespaceResponse>

Calls UpdateNamespace.

Parameters

NameTypeDescription
requestIUpdateNamespaceRequestUpdateNamespaceRequest message or plain object

Returns

Promise<UpdateNamespaceResponse>

Promise


updateSchedule

updateSchedule(request, callback): void

Calls UpdateSchedule.

Parameters

NameTypeDescription
requestIUpdateScheduleRequestUpdateScheduleRequest message or plain object
callbackUpdateScheduleCallbackNode-style callback called with the error, if any, and UpdateScheduleResponse

Returns

void

Promise

updateSchedule(request): Promise<UpdateScheduleResponse>

Calls UpdateSchedule.

Parameters

NameTypeDescription
requestIUpdateScheduleRequestUpdateScheduleRequest 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

NameTypeDescription
rpcImplRPCImplRPC implementation
requestDelimited?boolean-
responseDelimited?boolean-

Returns

WorkflowService

RPC service. Useful where requests and/or responses are streamed.