package temporal.api.operatorservice.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service OperatorService
service.proto:20OperatorService 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.
(-- Search Attribute --)
AddOrUpdateRemoteCluster adds or updates remote cluster.
message
request_response.proto:63string frontend_address = 1
Frontend Address is a cross cluster accessible address for gRPC traffic. This field is required.
bool enable_remote_cluster_connection = 2
Flag to enable / disable the cross cluster connection.
string frontend_http_address = 3
Frontend HTTP Address is a cross cluster accessible address for HTTP traffic. This field is optional. If not provided on update, the existing HTTP address will be removed.
bool enable_replication = 4
Controls whether replication streams are active.
message
request_response.proto:75(message has no fields)
rpc AddSearchAttributes (, )
service.proto:27AddSearchAttributes 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,
message
request_response.proto:18map<string, enums.v1.IndexedValueType> search_attributes = 1
Mapping between search attribute name and its IndexedValueType.
string namespace = 2
message
request_response.proto:24(message has no fields)
rpc CreateNexusEndpoint (, )
service.proto:75Create 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.
message
request_response.proto:125optional spec = 1
Endpoint definition to create.
message
request_response.proto:130optional endpoint = 1
Data post acceptance. Can be used to issue additional updates to this record.
rpc DeleteNamespace (, )
service.proto:47DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
message
request_response.proto:49string namespace = 1
Only one of namespace or namespace_id must be specified to identify namespace.
string namespace_id = 2
optional namespace_delete_delay = 3
If provided, the deletion of namespace info will be delayed for the given duration (0 means no delay). If not provided, the default delay configured in the cluster will be used.
message
request_response.proto:58string deleted_namespace = 1
Temporary namespace name that is used during reclaim resources step.
rpc DeleteNexusEndpoint (, )
service.proto:103Delete an incoming Nexus service by ID.
message
request_response.proto:149string id = 1
Server-generated unique endpoint ID.
int64 version = 2
Data version for this endpoint. Must match current version.
message
request_response.proto:156(message has no fields)
rpc GetNexusEndpoint (, )
service.proto:63Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.
message
request_response.proto:116string id = 1
Server-generated unique endpoint ID.
message
request_response.proto:121optional endpoint = 1
rpc ListClusters (, )
service.proto:59ListClusters returns information about Temporal clusters.
message
request_response.proto:86int32 page_size = 1
bytes next_page_token = 2
message
request_response.proto:91repeated clusters = 1
List of all cluster information
bytes next_page_token = 4
rpc ListNexusEndpoints (, )
service.proto:116List 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.
message
request_response.proto:159int32 page_size = 1
bytes next_page_token = 2
To get the next page, pass in `ListNexusEndpointsResponse.next_page_token` from the previous page's response, the token will be empty if there's no other page. Note: the last page may be empty if the total number of endpoints registered is a multiple of the page size.
string name = 3
Name of the incoming endpoint to filter on - optional. Specifying this will result in zero or one results. (-- api-linter: core::203::field-behavior-required=disabled aip.dev/not-precedent: Not following linter rules. --)
message
request_response.proto:171bytes next_page_token = 1
Token for getting the next page.
repeated endpoints = 2
rpc ListSearchAttributes (, )
service.proto:37ListSearchAttributes returns comprehensive information about search attributes.
message
request_response.proto:36string namespace = 1
message
request_response.proto:40map<string, enums.v1.IndexedValueType> custom_attributes = 1
Mapping between custom (user-registered) search attribute name to its IndexedValueType.
map<string, enums.v1.IndexedValueType> system_attributes = 2
Mapping between system (predefined) search attribute name to its IndexedValueType.
map<string, string> storage_schema = 3
Mapping from the attribute name to the visibility storage native type.
rpc RemoveRemoteCluster (, )
service.proto:55RemoveRemoteCluster removes remote cluster.
message
request_response.proto:78string cluster_name = 1
Remote cluster name to be removed.
message
request_response.proto:83(message has no fields)
RemoveSearchAttributes removes custom search attributes. Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
message
request_response.proto:27repeated string search_attributes = 1
Search attribute names to delete.
string namespace = 2
message
request_response.proto:33(message has no fields)
rpc UpdateNexusEndpoint (, )
service.proto:91Optimistically 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.
message
request_response.proto:135string id = 1
Server-generated unique endpoint ID.
int64 version = 2
Data version for this endpoint. Must match current version.
optional spec = 3
message
request_response.proto:144optional endpoint = 1
Data post acceptance. Can be used to issue additional updates to this record.
message
request_response.proto:97Used in:
string cluster_name = 1
Name of the cluster name.
string cluster_id = 2
Id of the cluster.
string address = 3
gRPC address.
string http_address = 7
HTTP address, if one exists.
int64 initial_failover_version = 4
A unique failover version across all connected clusters.
int32 history_shard_count = 5
History service shard number.
bool is_connection_enabled = 6
A flag to indicate if a connection is active.
bool is_replication_enabled = 8
A flag to indicate if replication is enabled.