Class: OperatorService

operatorservice.v1.OperatorService

Represents an OperatorService

Hierarchy

• Service

  ↳ OperatorService

Constructors

constructor

• new OperatorService(rpcImpl, requestDelimited?, responseDelimited?)

Constructs a new OperatorService service.

Parameters

Name	Type	Description
rpcImpl	RPCImpl	RPC 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

addOrUpdateRemoteCluster

▸ addOrUpdateRemoteCluster(request, callback): void

Calls AddOrUpdateRemoteCluster.

Parameters

Name	Type	Description
request	IAddOrUpdateRemoteClusterRequest	AddOrUpdateRemoteClusterRequest message or plain object
callback	AddOrUpdateRemoteClusterCallback	Node-style callback called with the error, if any, and AddOrUpdateRemoteClusterResponse

Returns

void

Promise

▸ addOrUpdateRemoteCluster(request): Promise<AddOrUpdateRemoteClusterResponse>

Calls AddOrUpdateRemoteCluster.

Parameters

Name	Type	Description
request	IAddOrUpdateRemoteClusterRequest	AddOrUpdateRemoteClusterRequest message or plain object

Returns

Promise<AddOrUpdateRemoteClusterResponse>

Promise

---

addSearchAttributes

▸ addSearchAttributes(request, callback): void

Calls AddSearchAttributes.

Parameters

Name	Type	Description
request	IAddSearchAttributesRequest	AddSearchAttributesRequest message or plain object
callback	AddSearchAttributesCallback	Node-style callback called with the error, if any, and AddSearchAttributesResponse

Returns

void

Promise

▸ addSearchAttributes(request): Promise<AddSearchAttributesResponse>

Calls AddSearchAttributes.

Parameters

Name	Type	Description
request	IAddSearchAttributesRequest	AddSearchAttributesRequest message or plain object

Returns

Promise<AddSearchAttributesResponse>

Promise

---

deleteNamespace

▸ deleteNamespace(request, callback): void

Calls DeleteNamespace.

Parameters

Name	Type	Description
request	IDeleteNamespaceRequest	DeleteNamespaceRequest message or plain object
callback	DeleteNamespaceCallback	Node-style callback called with the error, if any, and DeleteNamespaceResponse

Returns

void

Promise

▸ deleteNamespace(request): Promise<DeleteNamespaceResponse>

Calls DeleteNamespace.

Parameters

Name	Type	Description
request	IDeleteNamespaceRequest	DeleteNamespaceRequest message or plain object

Returns

Promise<DeleteNamespaceResponse>

Promise

---

deleteWorkflowExecution

▸ deleteWorkflowExecution(request, callback): void

Calls DeleteWorkflowExecution.

Parameters

Name	Type	Description
request	IDeleteWorkflowExecutionRequest	DeleteWorkflowExecutionRequest message or plain object
callback	DeleteWorkflowExecutionCallback	Node-style callback called with the error, if any, and DeleteWorkflowExecutionResponse

Returns

void

Promise

▸ deleteWorkflowExecution(request): Promise<DeleteWorkflowExecutionResponse>

Calls DeleteWorkflowExecution.

Parameters

Name	Type	Description
request	IDeleteWorkflowExecutionRequest	DeleteWorkflowExecutionRequest message or plain object

Returns

Promise<DeleteWorkflowExecutionResponse>

Promise

---

describeCluster

▸ describeCluster(request, callback): void

Calls DescribeCluster.

Parameters

Name	Type	Description
request	IDescribeClusterRequest	DescribeClusterRequest message or plain object
callback	DescribeClusterCallback	Node-style callback called with the error, if any, and DescribeClusterResponse

Returns

void

Promise

▸ describeCluster(request): Promise<DescribeClusterResponse>

Calls DescribeCluster.

Parameters

Name	Type	Description
request	IDescribeClusterRequest	DescribeClusterRequest message or plain object

Returns

Promise<DescribeClusterResponse>

Promise

---

emit

▸ emit(evt, ...args): OperatorService

Emits an event by calling its listeners with the specified arguments.

Parameters

Name	Type	Description
evt	string	Event name
...args	any[]	Arguments

Returns

OperatorService

this

Inherited from

$protobuf.rpc.Service.emit

---

end

▸ end(endedByRPC?): Service

Ends this service and emits the end event.

Parameters

Name	Type
endedByRPC?	boolean

Returns

Service

this

Inherited from

$protobuf.rpc.Service.end

---

listClusterMembers

▸ listClusterMembers(request, callback): void

Calls ListClusterMembers.

Parameters

Name	Type	Description
request	IListClusterMembersRequest	ListClusterMembersRequest message or plain object
callback	ListClusterMembersCallback	Node-style callback called with the error, if any, and ListClusterMembersResponse

Returns

void

Promise

▸ listClusterMembers(request): Promise<ListClusterMembersResponse>

Calls ListClusterMembers.

Parameters

Name	Type	Description
request	IListClusterMembersRequest	ListClusterMembersRequest message or plain object

Returns

Promise<ListClusterMembersResponse>

Promise

---

listClusters

▸ listClusters(request, callback): void

Calls ListClusters.

Parameters

Name	Type	Description
request	IListClustersRequest	ListClustersRequest message or plain object
callback	ListClustersCallback	Node-style callback called with the error, if any, and ListClustersResponse

Returns

void

Promise

▸ listClusters(request): Promise<ListClustersResponse>

Calls ListClusters.

Parameters

Name	Type	Description
request	IListClustersRequest	ListClustersRequest message or plain object

Returns

Promise<ListClustersResponse>

Promise

---

listSearchAttributes

▸ listSearchAttributes(request, callback): void

Calls ListSearchAttributes.

Parameters

Name	Type	Description
request	IListSearchAttributesRequest	ListSearchAttributesRequest message or plain object
callback	ListSearchAttributesCallback	Node-style callback called with the error, if any, and ListSearchAttributesResponse

Returns

void

Promise

▸ listSearchAttributes(request): Promise<ListSearchAttributesResponse>

Calls ListSearchAttributes.

Parameters

Name	Type	Description
request	IListSearchAttributesRequest	ListSearchAttributesRequest message or plain object

Returns

Promise<ListSearchAttributesResponse>

Promise

---

off

▸ off(evt?, fn?): OperatorService

Removes an event listener or any matching listeners if arguments are omitted.

Parameters

Name	Type
evt?	string
fn?	EventEmitterListener

Returns

OperatorService

this

Inherited from

$protobuf.rpc.Service.off

---

on

▸ on(evt, fn, ctx?): OperatorService

Registers an event listener.

Parameters

Name	Type	Description
evt	string	Event name
fn	EventEmitterListener	Listener
ctx?	any	-

Returns

OperatorService

this

Inherited from

$protobuf.rpc.Service.on

---

removeRemoteCluster

▸ removeRemoteCluster(request, callback): void

Calls RemoveRemoteCluster.

Parameters

Name	Type	Description
request	IRemoveRemoteClusterRequest	RemoveRemoteClusterRequest message or plain object
callback	RemoveRemoteClusterCallback	Node-style callback called with the error, if any, and RemoveRemoteClusterResponse

Returns

void

Promise

▸ removeRemoteCluster(request): Promise<RemoveRemoteClusterResponse>

Calls RemoveRemoteCluster.

Parameters

Name	Type	Description
request	IRemoveRemoteClusterRequest	RemoveRemoteClusterRequest message or plain object

Returns

Promise<RemoveRemoteClusterResponse>

Promise

---

removeSearchAttributes

▸ removeSearchAttributes(request, callback): void

Calls RemoveSearchAttributes.

Parameters

Name	Type	Description
request	IRemoveSearchAttributesRequest	RemoveSearchAttributesRequest message or plain object
callback	RemoveSearchAttributesCallback	Node-style callback called with the error, if any, and RemoveSearchAttributesResponse

Returns

void

Promise

▸ removeSearchAttributes(request): Promise<RemoveSearchAttributesResponse>

Calls RemoveSearchAttributes.

Parameters

Name	Type	Description
request	IRemoveSearchAttributesRequest	RemoveSearchAttributesRequest message or plain object

Returns

Promise<RemoveSearchAttributesResponse>

Promise

---

rpcCall

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

Calls a service method through {@link 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

---

create

▸ Static create(rpcImpl, requestDelimited?, responseDelimited?): OperatorService

Creates new OperatorService service using the specified rpc implementation.

Parameters

Name	Type	Description
rpcImpl	RPCImpl	RPC implementation
requestDelimited?	boolean	-
responseDelimited?	boolean	-

Returns

OperatorService

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