momento.auth.AuthOuterClassGrpcKt.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client-protos-jvm Show documentation
Kotlin protobuf protocols for the JVM that define the Momento gRPC wire format
There is a newer version: 0.119.4
package momento.auth

import io.grpc.CallOptions
import io.grpc.CallOptions.DEFAULT
import io.grpc.Channel
import io.grpc.Metadata
import io.grpc.MethodDescriptor
import io.grpc.ServerServiceDefinition
import io.grpc.ServerServiceDefinition.builder
import io.grpc.ServiceDescriptor
import io.grpc.Status.UNIMPLEMENTED
import io.grpc.StatusException
import io.grpc.kotlin.AbstractCoroutineServerImpl
import io.grpc.kotlin.AbstractCoroutineStub
import io.grpc.kotlin.ClientCalls.serverStreamingRpc
import io.grpc.kotlin.ClientCalls.unaryRpc
import io.grpc.kotlin.ServerCalls.serverStreamingServerMethodDefinition
import io.grpc.kotlin.ServerCalls.unaryServerMethodDefinition
import io.grpc.kotlin.StubFor
import kotlin.String
import kotlin.coroutines.CoroutineContext
import kotlin.coroutines.EmptyCoroutineContext
import kotlin.jvm.JvmOverloads
import kotlin.jvm.JvmStatic
import kotlinx.coroutines.flow.Flow
import momento.auth.AuthGrpc.getServiceDescriptor

/**
 * Holder for Kotlin coroutine-based client and server APIs for auth.Auth.
 */
public object AuthGrpcKt {
  public const val SERVICE_NAME: String = AuthGrpc.SERVICE_NAME

  @JvmStatic
  public val serviceDescriptor: ServiceDescriptor
    get() = getServiceDescriptor()

  public val loginMethod: MethodDescriptor<_LoginRequest, _LoginResponse>
    @JvmStatic
    get() = AuthGrpc.getLoginMethod()

  public val generateApiTokenMethod:
      MethodDescriptor<_GenerateApiTokenRequest, _GenerateApiTokenResponse>
    @JvmStatic
    get() = AuthGrpc.getGenerateApiTokenMethod()

  public val refreshApiTokenMethod:
      MethodDescriptor<_RefreshApiTokenRequest, _RefreshApiTokenResponse>
    @JvmStatic
    get() = AuthGrpc.getRefreshApiTokenMethod()

  /**
   * A stub for issuing RPCs to a(n) auth.Auth service as suspending coroutines.
   */
  @StubFor(AuthGrpc::class)
  public class AuthCoroutineStub @JvmOverloads constructor(
    channel: Channel,
    callOptions: CallOptions = DEFAULT,
  ) : AbstractCoroutineStub(channel, callOptions) {
    override fun build(channel: Channel, callOptions: CallOptions): AuthCoroutineStub =
        AuthCoroutineStub(channel, callOptions)

    /**
     * Returns a [Flow] that, when collected, executes this RPC and emits responses from the
     * server as they arrive.  That flow finishes normally if the server closes its response with
     * [`Status.OK`][io.grpc.Status], and fails by throwing a [StatusException] otherwise.  If
     * collecting the flow downstream fails exceptionally (including via cancellation), the RPC
     * is cancelled with that exception as a cause.
     *
     * @param request The request message to send to the server.
     *
     * @param headers Metadata to attach to the request.  Most users will not need this.
     *
     * @return A flow that, when collected, emits the responses from the server.
     */
    public fun login(request: _LoginRequest, headers: Metadata = Metadata()): Flow<_LoginResponse> =
        serverStreamingRpc(
      channel,
      AuthGrpc.getLoginMethod(),
      request,
      callOptions,
      headers
    )

    /**
     * Executes this RPC and returns the response message, suspending until the RPC completes
     * with [`Status.OK`][io.grpc.Status].  If the RPC completes with another status, a
     * corresponding
     * [StatusException] is thrown.  If this coroutine is cancelled, the RPC is also cancelled
     * with the corresponding exception as a cause.
     *
     * @param request The request message to send to the server.
     *
     * @param headers Metadata to attach to the request.  Most users will not need this.
     *
     * @return The single response from the server.
     */
    public suspend fun generateApiToken(request: _GenerateApiTokenRequest, headers: Metadata =
        Metadata()): _GenerateApiTokenResponse = unaryRpc(
      channel,
      AuthGrpc.getGenerateApiTokenMethod(),
      request,
      callOptions,
      headers
    )

    /**
     * Executes this RPC and returns the response message, suspending until the RPC completes
     * with [`Status.OK`][io.grpc.Status].  If the RPC completes with another status, a
     * corresponding
     * [StatusException] is thrown.  If this coroutine is cancelled, the RPC is also cancelled
     * with the corresponding exception as a cause.
     *
     * @param request The request message to send to the server.
     *
     * @param headers Metadata to attach to the request.  Most users will not need this.
     *
     * @return The single response from the server.
     */
    public suspend fun refreshApiToken(request: _RefreshApiTokenRequest, headers: Metadata =
        Metadata()): _RefreshApiTokenResponse = unaryRpc(
      channel,
      AuthGrpc.getRefreshApiTokenMethod(),
      request,
      callOptions,
      headers
    )
  }

  /**
   * Skeletal implementation of the auth.Auth service based on Kotlin coroutines.
   */
  public abstract class AuthCoroutineImplBase(
    coroutineContext: CoroutineContext = EmptyCoroutineContext,
  ) : AbstractCoroutineServerImpl(coroutineContext) {
    /**
     * Returns a [Flow] of responses to an RPC for auth.Auth.Login.
     *
     * If creating or collecting the returned flow fails with a [StatusException], the RPC
     * will fail with the corresponding [io.grpc.Status].  If it fails with a
     * [java.util.concurrent.CancellationException], the RPC will fail with status
     * `Status.CANCELLED`.  If creating
     * or collecting the returned flow fails for any other reason, the RPC will fail with
     * `Status.UNKNOWN` with the exception as a cause.
     *
     * @param request The request from the client.
     */
    public open fun login(request: _LoginRequest): Flow<_LoginResponse> = throw
        StatusException(UNIMPLEMENTED.withDescription("Method auth.Auth.Login is unimplemented"))

    /**
     * Returns the response to an RPC for auth.Auth.GenerateApiToken.
     *
     * If this method fails with a [StatusException], the RPC will fail with the corresponding
     * [io.grpc.Status].  If this method fails with a [java.util.concurrent.CancellationException],
     * the RPC will fail
     * with status `Status.CANCELLED`.  If this method fails for any other reason, the RPC will
     * fail with `Status.UNKNOWN` with the exception as a cause.
     *
     * @param request The request from the client.
     */
    public open suspend fun generateApiToken(request: _GenerateApiTokenRequest):
        _GenerateApiTokenResponse = throw
        StatusException(UNIMPLEMENTED.withDescription("Method auth.Auth.GenerateApiToken is unimplemented"))

    /**
     * Returns the response to an RPC for auth.Auth.RefreshApiToken.
     *
     * If this method fails with a [StatusException], the RPC will fail with the corresponding
     * [io.grpc.Status].  If this method fails with a [java.util.concurrent.CancellationException],
     * the RPC will fail
     * with status `Status.CANCELLED`.  If this method fails for any other reason, the RPC will
     * fail with `Status.UNKNOWN` with the exception as a cause.
     *
     * @param request The request from the client.
     */
    public open suspend fun refreshApiToken(request: _RefreshApiTokenRequest):
        _RefreshApiTokenResponse = throw
        StatusException(UNIMPLEMENTED.withDescription("Method auth.Auth.RefreshApiToken is unimplemented"))

    final override fun bindService(): ServerServiceDefinition = builder(getServiceDescriptor())
      .addMethod(serverStreamingServerMethodDefinition(
      context = this.context,
      descriptor = AuthGrpc.getLoginMethod(),
      implementation = ::login
    ))
      .addMethod(unaryServerMethodDefinition(
      context = this.context,
      descriptor = AuthGrpc.getGenerateApiTokenMethod(),
      implementation = ::generateApiToken
    ))
      .addMethod(unaryServerMethodDefinition(
      context = this.context,
      descriptor = AuthGrpc.getRefreshApiTokenMethod(),
      implementation = ::refreshApiToken
    )).build()
  }
}