Package com.buildless.service.v1

Interface ClientConfigGrpc.AsyncService

All Known Implementing Classes:
ClientConfigGrpc.ClientConfigImplBase
Enclosing class:
ClientConfigGrpc
public static interface ClientConfigGrpc.AsyncService
 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.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    clientConfig(CacheConfigRequest request, io.grpc.stub.StreamObserver<CacheConfigResponse> responseObserver)
    ## Cache Configuration Retrieve configuration which describes the current service instance.
    default void
    credentialsActivate(ClientSession request, io.grpc.stub.StreamObserver<ClientSessionTicket> responseObserver)
    ## Activate Credentials Executed from a CLI or other native build client, once a user has logged-in.
    default void
    credentialsCheck(CredentialCheckRequest request, io.grpc.stub.StreamObserver<CredentialCheckResponse> responseObserver)
    ## Credential Check Check a suite of end-user credentials for validity; this method is used from clients, SDKs, and other end-user agents.

  • Method Details

    • clientConfig

      default void clientConfig(CacheConfigRequest request, io.grpc.stub.StreamObserver<CacheConfigResponse> responseObserver)
       ## 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

      default void credentialsCheck(CredentialCheckRequest request, io.grpc.stub.StreamObserver<CredentialCheckResponse> responseObserver)
       ## Credential Check
 Check a suite of end-user credentials for validity; this method is used from clients, SDKs, and other end-user agents.

    • credentialsActivate

      default void credentialsActivate(ClientSession request, io.grpc.stub.StreamObserver<ClientSessionTicket> responseObserver)
       ## 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.