Namespace: OperatorService

operatorservice.v1.OperatorService

Type Aliases

AddOrUpdateRemoteCluster

Ƭ AddOrUpdateRemoteCluster: Object

AddOrUpdateRemoteCluster adds or updates remote cluster.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IAddOrUpdateRemoteClusterRequest
callback	AddOrUpdateRemoteClusterCallback

Returns

void

▸ (request): Promise<AddOrUpdateRemoteClusterResponse>

Parameters

Name	Type
request	IAddOrUpdateRemoteClusterRequest

Returns

Promise<AddOrUpdateRemoteClusterResponse>

Type declaration

Name	Type
name	"AddOrUpdateRemoteCluster"
path	"/temporal.api.operatorservice.v1.OperatorService/AddOrUpdateRemoteCluster"
requestStream	undefined
requestType	"AddOrUpdateRemoteClusterRequest"
responseStream	undefined
responseType	"AddOrUpdateRemoteClusterResponse"

---

AddOrUpdateRemoteClusterCallback

Ƭ AddOrUpdateRemoteClusterCallback: (error: Error | null, response?: AddOrUpdateRemoteClusterResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#addOrUpdateRemoteCluster.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	AddOrUpdateRemoteClusterResponse	AddOrUpdateRemoteClusterResponse

Returns

void

---

AddSearchAttributes

Ƭ AddSearchAttributes: Object

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,

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IAddSearchAttributesRequest
callback	AddSearchAttributesCallback

Returns

void

▸ (request): Promise<AddSearchAttributesResponse>

Parameters

Name	Type
request	IAddSearchAttributesRequest

Returns

Promise<AddSearchAttributesResponse>

Type declaration

Name	Type
name	"AddSearchAttributes"
path	"/temporal.api.operatorservice.v1.OperatorService/AddSearchAttributes"
requestStream	undefined
requestType	"AddSearchAttributesRequest"
responseStream	undefined
responseType	"AddSearchAttributesResponse"

---

AddSearchAttributesCallback

Ƭ AddSearchAttributesCallback: (error: Error | null, response?: AddSearchAttributesResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#addSearchAttributes.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	AddSearchAttributesResponse	AddSearchAttributesResponse

Returns

void

---

CreateNexusEndpoint

Ƭ CreateNexusEndpoint: Object

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.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	ICreateNexusEndpointRequest
callback	CreateNexusEndpointCallback

Returns

void

▸ (request): Promise<CreateNexusEndpointResponse>

Parameters

Name	Type
request	ICreateNexusEndpointRequest

Returns

Promise<CreateNexusEndpointResponse>

Type declaration

Name	Type
name	"CreateNexusEndpoint"
path	"/temporal.api.operatorservice.v1.OperatorService/CreateNexusEndpoint"
requestStream	undefined
requestType	"CreateNexusEndpointRequest"
responseStream	undefined
responseType	"CreateNexusEndpointResponse"

---

CreateNexusEndpointCallback

Ƭ CreateNexusEndpointCallback: (error: Error | null, response?: CreateNexusEndpointResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#createNexusEndpoint.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	CreateNexusEndpointResponse	CreateNexusEndpointResponse

Returns

void

---

DeleteNamespace

Ƭ DeleteNamespace: Object

DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteNamespaceRequest
callback	DeleteNamespaceCallback

Returns

void

▸ (request): Promise<DeleteNamespaceResponse>

Parameters

Name	Type
request	IDeleteNamespaceRequest

Returns

Promise<DeleteNamespaceResponse>

Type declaration

Name	Type
name	"DeleteNamespace"
path	"/temporal.api.operatorservice.v1.OperatorService/DeleteNamespace"
requestStream	undefined
requestType	"DeleteNamespaceRequest"
responseStream	undefined
responseType	"DeleteNamespaceResponse"

---

DeleteNamespaceCallback

Ƭ DeleteNamespaceCallback: (error: Error | null, response?: DeleteNamespaceResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#deleteNamespace.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteNamespaceResponse	DeleteNamespaceResponse

Returns

void

---

DeleteNexusEndpoint

Ƭ DeleteNexusEndpoint: Object

Delete an incoming Nexus service by ID.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IDeleteNexusEndpointRequest
callback	DeleteNexusEndpointCallback

Returns

void

▸ (request): Promise<DeleteNexusEndpointResponse>

Parameters

Name	Type
request	IDeleteNexusEndpointRequest

Returns

Promise<DeleteNexusEndpointResponse>

Type declaration

Name	Type
name	"DeleteNexusEndpoint"
path	"/temporal.api.operatorservice.v1.OperatorService/DeleteNexusEndpoint"
requestStream	undefined
requestType	"DeleteNexusEndpointRequest"
responseStream	undefined
responseType	"DeleteNexusEndpointResponse"

---

DeleteNexusEndpointCallback

Ƭ DeleteNexusEndpointCallback: (error: Error | null, response?: DeleteNexusEndpointResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#deleteNexusEndpoint.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	DeleteNexusEndpointResponse	DeleteNexusEndpointResponse

Returns

void

---

GetNexusEndpoint

Ƭ GetNexusEndpoint: Object

Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IGetNexusEndpointRequest
callback	GetNexusEndpointCallback

Returns

void

▸ (request): Promise<GetNexusEndpointResponse>

Parameters

Name	Type
request	IGetNexusEndpointRequest

Returns

Promise<GetNexusEndpointResponse>

Type declaration

Name	Type
name	"GetNexusEndpoint"
path	"/temporal.api.operatorservice.v1.OperatorService/GetNexusEndpoint"
requestStream	undefined
requestType	"GetNexusEndpointRequest"
responseStream	undefined
responseType	"GetNexusEndpointResponse"

---

GetNexusEndpointCallback

Ƭ GetNexusEndpointCallback: (error: Error | null, response?: GetNexusEndpointResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#getNexusEndpoint.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	GetNexusEndpointResponse	GetNexusEndpointResponse

Returns

void

---

ListClusters

Ƭ ListClusters: Object

ListClusters returns information about Temporal clusters.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListClustersRequest
callback	ListClustersCallback

Returns

void

▸ (request): Promise<ListClustersResponse>

Parameters

Name	Type
request	IListClustersRequest

Returns

Promise<ListClustersResponse>

Type declaration

Name	Type
name	"ListClusters"
path	"/temporal.api.operatorservice.v1.OperatorService/ListClusters"
requestStream	undefined
requestType	"ListClustersRequest"
responseStream	undefined
responseType	"ListClustersResponse"

---

ListClustersCallback

Ƭ ListClustersCallback: (error: Error | null, response?: ListClustersResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#listClusters.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListClustersResponse	ListClustersResponse

Returns

void

---

ListNexusEndpoints

Ƭ ListNexusEndpoints: Object

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.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListNexusEndpointsRequest
callback	ListNexusEndpointsCallback

Returns

void

▸ (request): Promise<ListNexusEndpointsResponse>

Parameters

Name	Type
request	IListNexusEndpointsRequest

Returns

Promise<ListNexusEndpointsResponse>

Type declaration

Name	Type
name	"ListNexusEndpoints"
path	"/temporal.api.operatorservice.v1.OperatorService/ListNexusEndpoints"
requestStream	undefined
requestType	"ListNexusEndpointsRequest"
responseStream	undefined
responseType	"ListNexusEndpointsResponse"

---

ListNexusEndpointsCallback

Ƭ ListNexusEndpointsCallback: (error: Error | null, response?: ListNexusEndpointsResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#listNexusEndpoints.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListNexusEndpointsResponse	ListNexusEndpointsResponse

Returns

void

---

ListSearchAttributes

Ƭ ListSearchAttributes: Object

ListSearchAttributes returns comprehensive information about search attributes.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IListSearchAttributesRequest
callback	ListSearchAttributesCallback

Returns

void

▸ (request): Promise<ListSearchAttributesResponse>

Parameters

Name	Type
request	IListSearchAttributesRequest

Returns

Promise<ListSearchAttributesResponse>

Type declaration

Name	Type
name	"ListSearchAttributes"
path	"/temporal.api.operatorservice.v1.OperatorService/ListSearchAttributes"
requestStream	undefined
requestType	"ListSearchAttributesRequest"
responseStream	undefined
responseType	"ListSearchAttributesResponse"

---

ListSearchAttributesCallback

Ƭ ListSearchAttributesCallback: (error: Error | null, response?: ListSearchAttributesResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#listSearchAttributes.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	ListSearchAttributesResponse	ListSearchAttributesResponse

Returns

void

---

RemoveRemoteCluster

Ƭ RemoveRemoteCluster: Object

RemoveRemoteCluster removes remote cluster.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRemoveRemoteClusterRequest
callback	RemoveRemoteClusterCallback

Returns

void

▸ (request): Promise<RemoveRemoteClusterResponse>

Parameters

Name	Type
request	IRemoveRemoteClusterRequest

Returns

Promise<RemoveRemoteClusterResponse>

Type declaration

Name	Type
name	"RemoveRemoteCluster"
path	"/temporal.api.operatorservice.v1.OperatorService/RemoveRemoteCluster"
requestStream	undefined
requestType	"RemoveRemoteClusterRequest"
responseStream	undefined
responseType	"RemoveRemoteClusterResponse"

---

RemoveRemoteClusterCallback

Ƭ RemoveRemoteClusterCallback: (error: Error | null, response?: RemoveRemoteClusterResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#removeRemoteCluster.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RemoveRemoteClusterResponse	RemoveRemoteClusterResponse

Returns

void

---

RemoveSearchAttributes

Ƭ RemoveSearchAttributes: Object

RemoveSearchAttributes removes custom search attributes.

Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IRemoveSearchAttributesRequest
callback	RemoveSearchAttributesCallback

Returns

void

▸ (request): Promise<RemoveSearchAttributesResponse>

Parameters

Name	Type
request	IRemoveSearchAttributesRequest

Returns

Promise<RemoveSearchAttributesResponse>

Type declaration

Name	Type
name	"RemoveSearchAttributes"
path	"/temporal.api.operatorservice.v1.OperatorService/RemoveSearchAttributes"
requestStream	undefined
requestType	"RemoveSearchAttributesRequest"
responseStream	undefined
responseType	"RemoveSearchAttributesResponse"

---

RemoveSearchAttributesCallback

Ƭ RemoveSearchAttributesCallback: (error: Error | null, response?: RemoveSearchAttributesResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#removeSearchAttributes.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	RemoveSearchAttributesResponse	RemoveSearchAttributesResponse

Returns

void

---

UpdateNexusEndpoint

Ƭ UpdateNexusEndpoint: Object

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.

Call signature

▸ (request, callback): void

Parameters

Name	Type
request	IUpdateNexusEndpointRequest
callback	UpdateNexusEndpointCallback

Returns

void

▸ (request): Promise<UpdateNexusEndpointResponse>

Parameters

Name	Type
request	IUpdateNexusEndpointRequest

Returns

Promise<UpdateNexusEndpointResponse>

Type declaration

Name	Type
name	"UpdateNexusEndpoint"
path	"/temporal.api.operatorservice.v1.OperatorService/UpdateNexusEndpoint"
requestStream	undefined
requestType	"UpdateNexusEndpointRequest"
responseStream	undefined
responseType	"UpdateNexusEndpointResponse"

---

UpdateNexusEndpointCallback

Ƭ UpdateNexusEndpointCallback: (error: Error | null, response?: UpdateNexusEndpointResponse) => void

Callback as used by temporal.api.operatorservice.v1.OperatorService#updateNexusEndpoint.

Type declaration

▸ (error, response?): void

Parameters

Name	Type	Description
error	Error | null	Error, if any
response?	UpdateNexusEndpointResponse	UpdateNexusEndpointResponse

Returns

void