Class OperatorServiceGrpc.OperatorServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<OperatorServiceGrpc.OperatorServiceFutureStub>
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.

  • Method Details

    • 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.

    • 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.

    • getNexusEndpoint

      public com.google.common.util.concurrent.ListenableFuture<GetNexusEndpointResponse> getNexusEndpoint(GetNexusEndpointRequest request)
       Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.

    • createNexusEndpoint

      public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<DeleteNexusEndpointResponse> deleteNexusEndpoint(DeleteNexusEndpointRequest request)
       Delete an incoming Nexus service by ID.

    • listNexusEndpoints

      public com.google.common.util.concurrent.ListenableFuture<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.