Skip to main content

Class: OperatorService

operatorservice.v1.OperatorService

Represents an OperatorService

Hierarchy

  • Service

    OperatorService

Constructors

constructor

new OperatorService(rpcImpl, requestDelimited?, responseDelimited?)

Constructs a new OperatorService 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

addOrUpdateRemoteCluster

addOrUpdateRemoteCluster(request, callback): void

Calls AddOrUpdateRemoteCluster.

Parameters

NameTypeDescription
requestIAddOrUpdateRemoteClusterRequestAddOrUpdateRemoteClusterRequest message or plain object
callbackAddOrUpdateRemoteClusterCallbackNode-style callback called with the error, if any, and AddOrUpdateRemoteClusterResponse

Returns

void

Promise

addOrUpdateRemoteCluster(request): Promise<AddOrUpdateRemoteClusterResponse>

Calls AddOrUpdateRemoteCluster.

Parameters

NameTypeDescription
requestIAddOrUpdateRemoteClusterRequestAddOrUpdateRemoteClusterRequest message or plain object

Returns

Promise<AddOrUpdateRemoteClusterResponse>

Promise


addSearchAttributes

addSearchAttributes(request, callback): void

Calls AddSearchAttributes.

Parameters

NameTypeDescription
requestIAddSearchAttributesRequestAddSearchAttributesRequest message or plain object
callbackAddSearchAttributesCallbackNode-style callback called with the error, if any, and AddSearchAttributesResponse

Returns

void

Promise

addSearchAttributes(request): Promise<AddSearchAttributesResponse>

Calls AddSearchAttributes.

Parameters

NameTypeDescription
requestIAddSearchAttributesRequestAddSearchAttributesRequest message or plain object

Returns

Promise<AddSearchAttributesResponse>

Promise


deleteNamespace

deleteNamespace(request, callback): void

Calls DeleteNamespace.

Parameters

NameTypeDescription
requestIDeleteNamespaceRequestDeleteNamespaceRequest message or plain object
callbackDeleteNamespaceCallbackNode-style callback called with the error, if any, and DeleteNamespaceResponse

Returns

void

Promise

deleteNamespace(request): Promise<DeleteNamespaceResponse>

Calls DeleteNamespace.

Parameters

NameTypeDescription
requestIDeleteNamespaceRequestDeleteNamespaceRequest message or plain object

Returns

Promise<DeleteNamespaceResponse>

Promise


deleteWorkflowExecution

deleteWorkflowExecution(request, callback): void

Calls DeleteWorkflowExecution.

Parameters

NameTypeDescription
requestIDeleteWorkflowExecutionRequestDeleteWorkflowExecutionRequest message or plain object
callbackDeleteWorkflowExecutionCallbackNode-style callback called with the error, if any, and DeleteWorkflowExecutionResponse

Returns

void

Promise

deleteWorkflowExecution(request): Promise<DeleteWorkflowExecutionResponse>

Calls DeleteWorkflowExecution.

Parameters

NameTypeDescription
requestIDeleteWorkflowExecutionRequestDeleteWorkflowExecutionRequest message or plain object

Returns

Promise<DeleteWorkflowExecutionResponse>

Promise


describeCluster

describeCluster(request, callback): void

Calls DescribeCluster.

Parameters

NameTypeDescription
requestIDescribeClusterRequestDescribeClusterRequest message or plain object
callbackDescribeClusterCallbackNode-style callback called with the error, if any, and DescribeClusterResponse

Returns

void

Promise

describeCluster(request): Promise<DescribeClusterResponse>

Calls DescribeCluster.

Parameters

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

NameTypeDescription
evtstringEvent name
...argsany[]Arguments

Returns

OperatorService

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


listClusterMembers

listClusterMembers(request, callback): void

Calls ListClusterMembers.

Parameters

NameTypeDescription
requestIListClusterMembersRequestListClusterMembersRequest message or plain object
callbackListClusterMembersCallbackNode-style callback called with the error, if any, and ListClusterMembersResponse

Returns

void

Promise

listClusterMembers(request): Promise<ListClusterMembersResponse>

Calls ListClusterMembers.

Parameters

NameTypeDescription
requestIListClusterMembersRequestListClusterMembersRequest message or plain object

Returns

Promise<ListClusterMembersResponse>

Promise


listClusters

listClusters(request, callback): void

Calls ListClusters.

Parameters

NameTypeDescription
requestIListClustersRequestListClustersRequest message or plain object
callbackListClustersCallbackNode-style callback called with the error, if any, and ListClustersResponse

Returns

void

Promise

listClusters(request): Promise<ListClustersResponse>

Calls ListClusters.

Parameters

NameTypeDescription
requestIListClustersRequestListClustersRequest message or plain object

Returns

Promise<ListClustersResponse>

Promise


listSearchAttributes

listSearchAttributes(request, callback): void

Calls ListSearchAttributes.

Parameters

NameTypeDescription
requestIListSearchAttributesRequestListSearchAttributesRequest message or plain object
callbackListSearchAttributesCallbackNode-style callback called with the error, if any, and ListSearchAttributesResponse

Returns

void

Promise

listSearchAttributes(request): Promise<ListSearchAttributesResponse>

Calls ListSearchAttributes.

Parameters

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

NameType
evt?string
fn?EventEmitterListener

Returns

OperatorService

this

Inherited from

$protobuf.rpc.Service.off


on

on(evt, fn, ctx?): OperatorService

Registers an event listener.

Parameters

NameTypeDescription
evtstringEvent name
fnEventEmitterListenerListener
ctx?any-

Returns

OperatorService

this

Inherited from

$protobuf.rpc.Service.on


removeRemoteCluster

removeRemoteCluster(request, callback): void

Calls RemoveRemoteCluster.

Parameters

NameTypeDescription
requestIRemoveRemoteClusterRequestRemoveRemoteClusterRequest message or plain object
callbackRemoveRemoteClusterCallbackNode-style callback called with the error, if any, and RemoveRemoteClusterResponse

Returns

void

Promise

removeRemoteCluster(request): Promise<RemoveRemoteClusterResponse>

Calls RemoveRemoteCluster.

Parameters

NameTypeDescription
requestIRemoveRemoteClusterRequestRemoveRemoteClusterRequest message or plain object

Returns

Promise<RemoveRemoteClusterResponse>

Promise


removeSearchAttributes

removeSearchAttributes(request, callback): void

Calls RemoveSearchAttributes.

Parameters

NameTypeDescription
requestIRemoveSearchAttributesRequestRemoveSearchAttributesRequest message or plain object
callbackRemoveSearchAttributesCallbackNode-style callback called with the error, if any, and RemoveSearchAttributesResponse

Returns

void

Promise

removeSearchAttributes(request): Promise<RemoveSearchAttributesResponse>

Calls RemoveSearchAttributes.

Parameters

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

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


create

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

Creates new OperatorService service using the specified rpc implementation.

Parameters

NameTypeDescription
rpcImplRPCImplRPC implementation
requestDelimited?boolean-
responseDelimited?boolean-

Returns

OperatorService

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