Class: OperatorService
operatorservice.v1.OperatorService
OperatorService API defines how Temporal SDKs and other clients interact with the Temporal server to perform administrative functions like registering a search attribute or a namespace. APIs in this file could be not compatible with Temporal Cloud, hence it's usage in SDKs should be limited by designated APIs that clearly state that they shouldn't be used by the main Application (Workflows & Activities) framework.
Hierarchy
-
Service↳
OperatorService
Constructors
constructor
• new OperatorService(rpcImpl, requestDelimited?, responseDelimited?): OperatorService
Constructs a new OperatorService service.
Parameters
| Name | Type | Description |
|---|---|---|
rpcImpl | RPCImpl | RPC implementation |
requestDelimited? | boolean | Whether requests are length-delimited |
responseDelimited? | boolean | Whether responses are length-delimited |
Returns
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
AddOrUpdateRemoteCluster adds or updates remote cluster.
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
▸ addOrUpdateRemoteCluster(request): Promise<AddOrUpdateRemoteClusterResponse>
AddOrUpdateRemoteCluster adds or updates remote cluster.
Parameters
| Name | Type | Description |
|---|---|---|
request | IAddOrUpdateRemoteClusterRequest | AddOrUpdateRemoteClusterRequest message or plain object |
Returns
Promise<AddOrUpdateRemoteClusterResponse>
Promise
addSearchAttributes
▸ addSearchAttributes(request, callback): void
AddSearchAttributes add custom search attributes.
Returns ALREADY_EXISTS status code if a Search Attribute with any of the specified names already exists Returns INTERNAL status code with temporal.api.errordetails.v1.SystemWorkflowFailure in Error Details if registration process fails,
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
▸ addSearchAttributes(request): Promise<AddSearchAttributesResponse>
AddSearchAttributes add custom search attributes.
Returns ALREADY_EXISTS status code if a Search Attribute with any of the specified names already exists Returns INTERNAL status code with temporal.api.errordetails.v1.SystemWorkflowFailure in Error Details if registration process fails,
Parameters
| Name | Type | Description |
|---|---|---|
request | IAddSearchAttributesRequest | AddSearchAttributesRequest message or plain object |
Returns
Promise<AddSearchAttributesResponse>
Promise
deleteNamespace
▸ deleteNamespace(request, callback): void
DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources. (-- api-linter: core::0135::method-signature=disabled aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --) (-- api-linter: core::0135::response-message-name=disabled aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
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
▸ deleteNamespace(request): Promise<DeleteNamespaceResponse>
DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources. (-- api-linter: core::0135::method-signature=disabled aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --) (-- api-linter: core::0135::response-message-name=disabled aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
Parameters
| Name | Type | Description |
|---|---|---|
request | IDeleteNamespaceRequest | DeleteNamespaceRequest message or plain object |
Returns
Promise<DeleteNamespaceResponse>
Promise
emit
▸ emit(evt, ...args): this
Emits an event by calling its listeners with the specified arguments.
Parameters
| Name | Type | Description |
|---|---|---|
evt | string | Event name |
...args | any[] | Arguments |
Returns
this
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
listClusters
▸ listClusters(request, callback): void
ListClusters returns information about Temporal clusters.
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
▸ listClusters(request): Promise<ListClustersResponse>
ListClusters returns information about Temporal clusters.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListClustersRequest | ListClustersRequest message or plain object |
Returns
Promise<ListClustersResponse>
Promise
listSearchAttributes
▸ listSearchAttributes(request, callback): void
ListSearchAttributes returns comprehensive information about search attributes.
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
▸ listSearchAttributes(request): Promise<ListSearchAttributesResponse>
ListSearchAttributes returns comprehensive information about search attributes.
Parameters
| Name | Type | Description |
|---|---|---|
request | IListSearchAttributesRequest | ListSearchAttributesRequest message or plain object |
Returns
Promise<ListSearchAttributesResponse>
Promise
off
▸ off(evt?, fn?): this
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
this
Inherited from
$protobuf.rpc.Service.off
on
▸ on(evt, fn, ctx?): this
Registers an event listener.
Parameters
| Name | Type | Description |
|---|---|---|
evt | string | Event name |
fn | EventEmitterListener | Listener |
ctx? | any | Listener context |
Returns
this
this
Inherited from
$protobuf.rpc.Service.on
removeRemoteCluster
▸ removeRemoteCluster(request, callback): void
RemoveRemoteCluster removes remote cluster.
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
▸ removeRemoteCluster(request): Promise<RemoveRemoteClusterResponse>
RemoveRemoteCluster removes remote cluster.
Parameters
| Name | Type | Description |
|---|---|---|
request | IRemoveRemoteClusterRequest | RemoveRemoteClusterRequest message or plain object |
Returns
Promise<RemoveRemoteClusterResponse>
Promise
removeSearchAttributes
▸ removeSearchAttributes(request, callback): void
RemoveSearchAttributes removes custom search attributes.
Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
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
▸ removeSearchAttributes(request): Promise<RemoveSearchAttributesResponse>
RemoveSearchAttributes removes custom search attributes.
Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
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 rpcImpl.
Type parameters
| Name | Type |
|---|---|
TReq | extends Message<TReq> |
TRes | extends Message<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
▸ create(rpcImpl, requestDelimited?, responseDelimited?): OperatorService
Creates new OperatorService 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.