Package io.temporal.api.operatorservice.v1

Class OperatorServiceGrpc.OperatorServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<OperatorServiceGrpc.OperatorServiceStub>

io.temporal.api.operatorservice.v1.OperatorServiceGrpc.OperatorServiceStub

Enclosing class:

OperatorServiceGrpc

public static final class OperatorServiceGrpc.OperatorServiceStub
extends io.grpc.stub.AbstractAsyncStub<OperatorServiceGrpc.OperatorServiceStub>

 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
void	addOrUpdateRemoteCluster(AddOrUpdateRemoteClusterRequest request, io.grpc.stub.StreamObserver<AddOrUpdateRemoteClusterResponse> responseObserver)	AddOrUpdateRemoteCluster adds or updates remote cluster.
void	addSearchAttributes(AddSearchAttributesRequest request, io.grpc.stub.StreamObserver<AddSearchAttributesResponse> responseObserver)	AddSearchAttributes add custom search attributes.
protected OperatorServiceGrpc.OperatorServiceStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	deleteNamespace(DeleteNamespaceRequest request, io.grpc.stub.StreamObserver<DeleteNamespaceResponse> responseObserver)	DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
void	listClusters(ListClustersRequest request, io.grpc.stub.StreamObserver<ListClustersResponse> responseObserver)	ListClusters returns information about Temporal clusters.
void	listSearchAttributes(ListSearchAttributesRequest request, io.grpc.stub.StreamObserver<ListSearchAttributesResponse> responseObserver)	ListSearchAttributes returns comprehensive information about search attributes.
void	removeRemoteCluster(RemoveRemoteClusterRequest request, io.grpc.stub.StreamObserver<RemoveRemoteClusterResponse> responseObserver)	RemoveRemoteCluster removes remote cluster.
void	removeSearchAttributes(RemoveSearchAttributesRequest request, io.grpc.stub.StreamObserver<RemoveSearchAttributesResponse> responseObserver)	RemoveSearchAttributes removes custom search attributes.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

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

Methods inherited from class java.lang.Object

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

Method Detail

build

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

Specified by:

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

addSearchAttributes

public void addSearchAttributes(AddSearchAttributesRequest request,
                                io.grpc.stub.StreamObserver<AddSearchAttributesResponse> responseObserver)

 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 void removeSearchAttributes(RemoveSearchAttributesRequest request,
                                   io.grpc.stub.StreamObserver<RemoveSearchAttributesResponse> responseObserver)

 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 void listSearchAttributes(ListSearchAttributesRequest request,
                                 io.grpc.stub.StreamObserver<ListSearchAttributesResponse> responseObserver)

 ListSearchAttributes returns comprehensive information about search attributes.
 

deleteNamespace

public void deleteNamespace(DeleteNamespaceRequest request,
                            io.grpc.stub.StreamObserver<DeleteNamespaceResponse> responseObserver)

 DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
 (-- api-linter: core::0135::method-signature=disabled
     aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
 (-- api-linter: core::0135::response-message-name=disabled
     aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
 

addOrUpdateRemoteCluster

public void addOrUpdateRemoteCluster(AddOrUpdateRemoteClusterRequest request,
                                     io.grpc.stub.StreamObserver<AddOrUpdateRemoteClusterResponse> responseObserver)

 AddOrUpdateRemoteCluster adds or updates remote cluster.
 

removeRemoteCluster

public void removeRemoteCluster(RemoveRemoteClusterRequest request,
                                io.grpc.stub.StreamObserver<RemoveRemoteClusterResponse> responseObserver)

 RemoveRemoteCluster removes remote cluster.
 

listClusters

public void listClusters(ListClustersRequest request,
                         io.grpc.stub.StreamObserver<ListClustersResponse> responseObserver)

 ListClusters returns information about Temporal clusters.