Package com.buildless.service.v1

Class ClientConfigGrpc.ClientConfigFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<ClientConfigGrpc.ClientConfigFutureStub>
com.buildless.service.v1.ClientConfigGrpc.ClientConfigFutureStub
Enclosing class:
ClientConfigGrpc
public static final class ClientConfigGrpc.ClientConfigFutureStub extends io.grpc.stub.AbstractFutureStub<ClientConfigGrpc.ClientConfigFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service ClientConfig. 
 Defines the API surface for methods which are provided to Buildless clients, SDKs, and tools. This service is used
 for things like checking configurations & credentials, performing login flows, and client-side routing and balancing.

  • 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
    protected ClientConfigGrpc.ClientConfigFutureStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    com.google.common.util.concurrent.ListenableFuture<CacheConfigResponse>
    clientConfig(CacheConfigRequest request)
    ## Cache Configuration Retrieve configuration which describes the current service instance.
    com.google.common.util.concurrent.ListenableFuture<ClientSessionTicket>
    credentialsActivate(ClientSession request)
    ## Activate Credentials Executed from a CLI or other native build client, once a user has logged-in.
    com.google.common.util.concurrent.ListenableFuture<CredentialCheckResponse>
    credentialsCheck(CredentialCheckRequest request)
    ## Credential Check Check a suite of end-user credentials for validity; this method is used from clients, SDKs, and other end-user agents.

    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 Details

    • build

      protected ClientConfigGrpc.ClientConfigFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<ClientConfigGrpc.ClientConfigFutureStub>

    • clientConfig

      public com.google.common.util.concurrent.ListenableFuture<CacheConfigResponse> clientConfig(CacheConfigRequest request)
       ## Cache Configuration
 Retrieve configuration which describes the current service instance.
 This method reveals whether the authenticated user is talking to a local or remote endpoint, and offers initial client configuration.

    • credentialsCheck

      public com.google.common.util.concurrent.ListenableFuture<CredentialCheckResponse> credentialsCheck(CredentialCheckRequest request)
       ## Credential Check
 Check a suite of end-user credentials for validity; this method is used from clients, SDKs, and other end-user agents.

    • credentialsActivate

      public com.google.common.util.concurrent.ListenableFuture<ClientSessionTicket> credentialsActivate(ClientSession request)
       ## Activate Credentials
 Executed from a CLI or other native build client, once a user has logged-in. If the user has access to multiple
 tenant contexts, the response presents them so the user may choose their default (as needed). API keys and other
 authorization material is returned here as well.
 The API key returned is the user's "default API key." This identifies the user account for regular cache traffic;
 the tenant ID may additionally be affixed to cache requests to scope to a specific tenant.