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
Properties
addOrUpdateRemoteCluster
• addOrUpdateRemoteCluster: AddOrUpdateRemoteCluster
AddOrUpdateRemoteCluster adds or updates remote cluster.
addSearchAttributes
• addSearchAttributes: AddSearchAttributes
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,
createNexusEndpoint
• createNexusEndpoint: CreateNexusEndpoint
Create a Nexus endpoint. This will fail if an endpoint with the same name is already registered with a status of ALREADY_EXISTS. Returns the created endpoint with its initial version. You may use this version for subsequent updates.
deleteNamespace
• deleteNamespace: DeleteNamespace
DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
deleteNexusEndpoint
• deleteNexusEndpoint: DeleteNexusEndpoint
Delete an incoming Nexus service by ID.
getNexusEndpoint
• getNexusEndpoint: GetNexusEndpoint
Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.
listClusters
• listClusters: ListClusters
ListClusters returns information about Temporal clusters.
listNexusEndpoints
• listNexusEndpoints: ListNexusEndpoints
List all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the next_page_token field of the previous response to get the next page of results. An empty next_page_token indicates that there are no more results. During pagination, a newly added service with an ID lexicographically earlier than the previous page's last endpoint's ID may be missed.
listSearchAttributes
• listSearchAttributes: ListSearchAttributes
ListSearchAttributes returns comprehensive information about search attributes.
removeRemoteCluster
• removeRemoteCluster: RemoveRemoteCluster
RemoveRemoteCluster removes remote cluster.
removeSearchAttributes
• removeSearchAttributes: RemoveSearchAttributes
RemoveSearchAttributes removes custom search attributes.
Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
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
updateNexusEndpoint
• updateNexusEndpoint: UpdateNexusEndpoint
Optimistically update a Nexus endpoint based on provided version as obtained via the GetNexusEndpoint or
ListNexusEndpointResponse APIs. This will fail with a status of FAILED_PRECONDITION if the version does not
match.
Returns the updated endpoint with its updated version. You may use this version for subsequent updates. You don't
need to increment the version yourself. The server will increment the version for you after each update.
Methods
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
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
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.