Skip to main content

OperatorService

Type Aliases​

AddOrUpdateRemoteCluster()​

AddOrUpdateRemoteCluster = void

AddOrUpdateRemoteCluster adds or updates remote cluster.

Call Signature​

AddOrUpdateRemoteCluster(request, callback): void

AddOrUpdateRemoteCluster adds or updates remote cluster.

Parameters​
request​

IAddOrUpdateRemoteClusterRequest

callback​

AddOrUpdateRemoteClusterCallback

Returns​

void

Call Signature​

AddOrUpdateRemoteCluster(request): Promise<AddOrUpdateRemoteClusterResponse>

AddOrUpdateRemoteCluster adds or updates remote cluster.

Parameters​
request​

IAddOrUpdateRemoteClusterRequest

Returns​

Promise<AddOrUpdateRemoteClusterResponse>

Properties​

name​

readonly name: "AddOrUpdateRemoteCluster"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/AddOrUpdateRemoteCluster"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "AddOrUpdateRemoteClusterRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "AddOrUpdateRemoteClusterResponse"

AddOrUpdateRemoteClusterCallback​

AddOrUpdateRemoteClusterCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

AddOrUpdateRemoteClusterResponse

AddOrUpdateRemoteClusterResponse

Returns​

void

AddSearchAttributes()​

AddSearchAttributes = 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,

Call Signature​

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​
request​

IAddSearchAttributesRequest

callback​

AddSearchAttributesCallback

Returns​

void

Call Signature​

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​
request​

IAddSearchAttributesRequest

Returns​

Promise<AddSearchAttributesResponse>

Properties​

name​

readonly name: "AddSearchAttributes"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/AddSearchAttributes"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "AddSearchAttributesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "AddSearchAttributesResponse"

AddSearchAttributesCallback​

AddSearchAttributesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

AddSearchAttributesResponse

AddSearchAttributesResponse

Returns​

void

CreateNexusEndpoint()​

CreateNexusEndpoint = void

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​

CreateNexusEndpoint(request, callback): void

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.

Parameters​
request​

ICreateNexusEndpointRequest

callback​

CreateNexusEndpointCallback

Returns​

void

Call Signature​

CreateNexusEndpoint(request): Promise<CreateNexusEndpointResponse>

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.

Parameters​
request​

ICreateNexusEndpointRequest

Returns​

Promise<CreateNexusEndpointResponse>

Properties​

name​

readonly name: "CreateNexusEndpoint"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/CreateNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "CreateNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "CreateNexusEndpointResponse"

CreateNexusEndpointCallback​

CreateNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

CreateNexusEndpointResponse

CreateNexusEndpointResponse

Returns​

void

DeleteNamespace()​

DeleteNamespace = void

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

Call Signature​

DeleteNamespace(request, callback): void

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

Parameters​
request​

IDeleteNamespaceRequest

callback​

DeleteNamespaceCallback

Returns​

void

Call Signature​

DeleteNamespace(request): Promise<DeleteNamespaceResponse>

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

Parameters​
request​

IDeleteNamespaceRequest

Returns​

Promise<DeleteNamespaceResponse>

Properties​

name​

readonly name: "DeleteNamespace"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/DeleteNamespace"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNamespaceRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNamespaceResponse"

DeleteNamespaceCallback​

DeleteNamespaceCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNamespaceResponse

DeleteNamespaceResponse

Returns​

void

DeleteNexusEndpoint()​

DeleteNexusEndpoint = void

Delete an incoming Nexus service by ID.

Call Signature​

DeleteNexusEndpoint(request, callback): void

Delete an incoming Nexus service by ID.

Parameters​
request​

IDeleteNexusEndpointRequest

callback​

DeleteNexusEndpointCallback

Returns​

void

Call Signature​

DeleteNexusEndpoint(request): Promise<DeleteNexusEndpointResponse>

Delete an incoming Nexus service by ID.

Parameters​
request​

IDeleteNexusEndpointRequest

Returns​

Promise<DeleteNexusEndpointResponse>

Properties​

name​

readonly name: "DeleteNexusEndpoint"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/DeleteNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "DeleteNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "DeleteNexusEndpointResponse"

DeleteNexusEndpointCallback​

DeleteNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

DeleteNexusEndpointResponse

DeleteNexusEndpointResponse

Returns​

void

GetNexusEndpoint()​

GetNexusEndpoint = void

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

Call Signature​

GetNexusEndpoint(request, callback): void

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

Parameters​
request​

IGetNexusEndpointRequest

callback​

GetNexusEndpointCallback

Returns​

void

Call Signature​

GetNexusEndpoint(request): Promise<GetNexusEndpointResponse>

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

Parameters​
request​

IGetNexusEndpointRequest

Returns​

Promise<GetNexusEndpointResponse>

Properties​

name​

readonly name: "GetNexusEndpoint"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/GetNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "GetNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "GetNexusEndpointResponse"

GetNexusEndpointCallback​

GetNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

GetNexusEndpointResponse

GetNexusEndpointResponse

Returns​

void

ListClusters()​

ListClusters = void

ListClusters returns information about Temporal clusters.

Call Signature​

ListClusters(request, callback): void

ListClusters returns information about Temporal clusters.

Parameters​
request​

IListClustersRequest

callback​

ListClustersCallback

Returns​

void

Call Signature​

ListClusters(request): Promise<ListClustersResponse>

ListClusters returns information about Temporal clusters.

Parameters​
request​

IListClustersRequest

Returns​

Promise<ListClustersResponse>

Properties​

name​

readonly name: "ListClusters"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/ListClusters"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListClustersRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListClustersResponse"

ListClustersCallback​

ListClustersCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListClustersResponse

ListClustersResponse

Returns​

void

ListNexusEndpoints()​

ListNexusEndpoints = void

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​

ListNexusEndpoints(request, callback): void

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.

Parameters​
request​

IListNexusEndpointsRequest

callback​

ListNexusEndpointsCallback

Returns​

void

Call Signature​

ListNexusEndpoints(request): Promise<ListNexusEndpointsResponse>

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.

Parameters​
request​

IListNexusEndpointsRequest

Returns​

Promise<ListNexusEndpointsResponse>

Properties​

name​

readonly name: "ListNexusEndpoints"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/ListNexusEndpoints"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListNexusEndpointsRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListNexusEndpointsResponse"

ListNexusEndpointsCallback​

ListNexusEndpointsCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListNexusEndpointsResponse

ListNexusEndpointsResponse

Returns​

void

ListSearchAttributes()​

ListSearchAttributes = void

ListSearchAttributes returns comprehensive information about search attributes.

Call Signature​

ListSearchAttributes(request, callback): void

ListSearchAttributes returns comprehensive information about search attributes.

Parameters​
request​

IListSearchAttributesRequest

callback​

ListSearchAttributesCallback

Returns​

void

Call Signature​

ListSearchAttributes(request): Promise<ListSearchAttributesResponse>

ListSearchAttributes returns comprehensive information about search attributes.

Parameters​
request​

IListSearchAttributesRequest

Returns​

Promise<ListSearchAttributesResponse>

Properties​

name​

readonly name: "ListSearchAttributes"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/ListSearchAttributes"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "ListSearchAttributesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "ListSearchAttributesResponse"

ListSearchAttributesCallback​

ListSearchAttributesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

ListSearchAttributesResponse

ListSearchAttributesResponse

Returns​

void

RemoveRemoteCluster()​

RemoveRemoteCluster = void

RemoveRemoteCluster removes remote cluster.

Call Signature​

RemoveRemoteCluster(request, callback): void

RemoveRemoteCluster removes remote cluster.

Parameters​
request​

IRemoveRemoteClusterRequest

callback​

RemoveRemoteClusterCallback

Returns​

void

Call Signature​

RemoveRemoteCluster(request): Promise<RemoveRemoteClusterResponse>

RemoveRemoteCluster removes remote cluster.

Parameters​
request​

IRemoveRemoteClusterRequest

Returns​

Promise<RemoveRemoteClusterResponse>

Properties​

name​

readonly name: "RemoveRemoteCluster"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/RemoveRemoteCluster"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RemoveRemoteClusterRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RemoveRemoteClusterResponse"

RemoveRemoteClusterCallback​

RemoveRemoteClusterCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RemoveRemoteClusterResponse

RemoveRemoteClusterResponse

Returns​

void

RemoveSearchAttributes()​

RemoveSearchAttributes = void

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​

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​
request​

IRemoveSearchAttributesRequest

callback​

RemoveSearchAttributesCallback

Returns​

void

Call Signature​

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​
request​

IRemoveSearchAttributesRequest

Returns​

Promise<RemoveSearchAttributesResponse>

Properties​

name​

readonly name: "RemoveSearchAttributes"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/RemoveSearchAttributes"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "RemoveSearchAttributesRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "RemoveSearchAttributesResponse"

RemoveSearchAttributesCallback​

RemoveSearchAttributesCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

RemoveSearchAttributesResponse

RemoveSearchAttributesResponse

Returns​

void

UpdateNexusEndpoint()​

UpdateNexusEndpoint = void

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​

UpdateNexusEndpoint(request, callback): void

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.

Parameters​
request​

IUpdateNexusEndpointRequest

callback​

UpdateNexusEndpointCallback

Returns​

void

Call Signature​

UpdateNexusEndpoint(request): Promise<UpdateNexusEndpointResponse>

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.

Parameters​
request​

IUpdateNexusEndpointRequest

Returns​

Promise<UpdateNexusEndpointResponse>

Properties​

name​

readonly name: "UpdateNexusEndpoint"

path​

readonly path: "/temporal.api.operatorservice.v1.OperatorService/UpdateNexusEndpoint"

requestStream​

readonly requestStream: undefined

requestType​

readonly requestType: "UpdateNexusEndpointRequest"

responseStream​

readonly responseStream: undefined

responseType​

readonly responseType: "UpdateNexusEndpointResponse"

UpdateNexusEndpointCallback​

UpdateNexusEndpointCallback = (error, response?) => void

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

Parameters​

error​

Error | null

Error, if any

response?​

UpdateNexusEndpointResponse

UpdateNexusEndpointResponse

Returns​

void