Package io.temporal.api.operatorservice.v1

Class OperatorServiceGrpc.OperatorServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<OperatorServiceGrpc.OperatorServiceFutureStub>

io.temporal.api.operatorservice.v1.OperatorServiceGrpc.OperatorServiceFutureStub

Enclosing class:

OperatorServiceGrpc

public static final class OperatorServiceGrpc.OperatorServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<OperatorServiceGrpc.OperatorServiceFutureStub>

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

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.OperatorServiceFutureStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

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

addSearchAttributes

public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<ListSearchAttributesResponse> listSearchAttributes(ListSearchAttributesRequest request)

 ListSearchAttributes returns comprehensive information about search attributes.
 

deleteNamespace

public com.google.common.util.concurrent.ListenableFuture<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<AddOrUpdateRemoteClusterResponse> addOrUpdateRemoteCluster(AddOrUpdateRemoteClusterRequest request)

 AddOrUpdateRemoteCluster adds or updates remote cluster.
 

removeRemoteCluster

public com.google.common.util.concurrent.ListenableFuture<RemoveRemoteClusterResponse> removeRemoteCluster(RemoveRemoteClusterRequest request)

 RemoveRemoteCluster removes remote cluster.
 

listClusters

public com.google.common.util.concurrent.ListenableFuture<ListClustersResponse> listClusters(ListClustersRequest request)

 ListClusters returns information about Temporal clusters.