Class OperatorServiceGrpc.OperatorServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<OperatorServiceGrpc.OperatorServiceBlockingStub>

io.grpc.stub.AbstractBlockingStub<OperatorServiceGrpc.OperatorServiceBlockingStub>

io.temporal.api.operatorservice.v1.OperatorServiceGrpc.OperatorServiceBlockingStub

Enclosing class:

OperatorServiceGrpc

public static final class OperatorServiceGrpc.OperatorServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<OperatorServiceGrpc.OperatorServiceBlockingStub>

 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
AddOrUpdateRemoteClusterResponse	addOrUpdateRemoteCluster(AddOrUpdateRemoteClusterRequest request)	AddOrUpdateRemoteCluster adds or updates remote cluster.
AddSearchAttributesResponse	addSearchAttributes(AddSearchAttributesRequest request)	AddSearchAttributes add custom search attributes.
protected OperatorServiceGrpc.OperatorServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
CreateNexusEndpointResponse	createNexusEndpoint(CreateNexusEndpointRequest request)	Create a Nexus endpoint.
DeleteNamespaceResponse	deleteNamespace(DeleteNamespaceRequest request)	DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
DeleteNexusEndpointResponse	deleteNexusEndpoint(DeleteNexusEndpointRequest request)	Delete an incoming Nexus service by ID.
GetNexusEndpointResponse	getNexusEndpoint(GetNexusEndpointRequest request)	Get a registered Nexus endpoint by ID.
ListClustersResponse	listClusters(ListClustersRequest request)	ListClusters returns information about Temporal clusters.
ListNexusEndpointsResponse	listNexusEndpoints(ListNexusEndpointsRequest request)	List all Nexus endpoints for the cluster, sorted by ID in ascending order.
ListSearchAttributesResponse	listSearchAttributes(ListSearchAttributesRequest request)	ListSearchAttributes returns comprehensive information about search attributes.
RemoveRemoteClusterResponse	removeRemoteCluster(RemoveRemoteClusterRequest request)	RemoveRemoteCluster removes remote cluster.
RemoveSearchAttributesResponse	removeSearchAttributes(RemoveSearchAttributesRequest request)	RemoveSearchAttributes removes custom search attributes.
UpdateNexusEndpointResponse	updateNexusEndpoint(UpdateNexusEndpointRequest request)	Optimistically update a Nexus endpoint based on provided version as obtained via the `GetNexusEndpoint` or `ListNexusEndpointResponse` APIs.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected OperatorServiceGrpc.OperatorServiceBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<OperatorServiceGrpc.OperatorServiceBlockingStub>

addSearchAttributes

public AddSearchAttributesResponse addSearchAttributes(AddSearchAttributesRequest request)

 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,
 

removeSearchAttributes

public RemoveSearchAttributesResponse removeSearchAttributes(RemoveSearchAttributesRequest request)

 RemoveSearchAttributes removes custom search attributes.
 Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
 

listSearchAttributes

public ListSearchAttributesResponse listSearchAttributes(ListSearchAttributesRequest request)

 ListSearchAttributes returns comprehensive information about search attributes.
 

deleteNamespace

public DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest request)

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

addOrUpdateRemoteCluster

public AddOrUpdateRemoteClusterResponse addOrUpdateRemoteCluster(AddOrUpdateRemoteClusterRequest request)

 AddOrUpdateRemoteCluster adds or updates remote cluster.
 

removeRemoteCluster

public RemoveRemoteClusterResponse removeRemoteCluster(RemoveRemoteClusterRequest request)

 RemoveRemoteCluster removes remote cluster.
 

listClusters

public ListClustersResponse listClusters(ListClustersRequest request)

 ListClusters returns information about Temporal clusters.
 

getNexusEndpoint

public GetNexusEndpointResponse getNexusEndpoint(GetNexusEndpointRequest request)

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

createNexusEndpoint

public CreateNexusEndpointResponse createNexusEndpoint(CreateNexusEndpointRequest request)

 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.
 

updateNexusEndpoint

public UpdateNexusEndpointResponse updateNexusEndpoint(UpdateNexusEndpointRequest request)

 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.
 

deleteNexusEndpoint

public DeleteNexusEndpointResponse deleteNexusEndpoint(DeleteNexusEndpointRequest request)

 Delete an incoming Nexus service by ID.
 

listNexusEndpoints

public ListNexusEndpointsResponse listNexusEndpoints(ListNexusEndpointsRequest request)

 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.