com.google.api.servicecontrol.v1.QuotaControllerGrpc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-google-cloud-service-control-v1 Show documentation
GRPC library for google-cloud-service-control
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.api.servicecontrol.v1;

import static io.grpc.MethodDescriptor.generateFullMethodName;

/**
 *
 *
 *  * [Google Quota Control API](/service-control/overview)
 * Allows clients to allocate and release quota against a [managed
 * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
 * 
 */
@javax.annotation.Generated(
    value = "by gRPC proto compiler",
    comments = "Source: google/api/servicecontrol/v1/quota_controller.proto")
@io.grpc.stub.annotations.GrpcGenerated
public final class QuotaControllerGrpc {

  private QuotaControllerGrpc() {}

  public static final java.lang.String SERVICE_NAME =
      "google.api.servicecontrol.v1.QuotaController";

  // Static method descriptors that strictly reflect the proto.
  private static volatile io.grpc.MethodDescriptor<
          com.google.api.servicecontrol.v1.AllocateQuotaRequest,
          com.google.api.servicecontrol.v1.AllocateQuotaResponse>
      getAllocateQuotaMethod;

  @io.grpc.stub.annotations.RpcMethod(
      fullMethodName = SERVICE_NAME + '/' + "AllocateQuota",
      requestType = com.google.api.servicecontrol.v1.AllocateQuotaRequest.class,
      responseType = com.google.api.servicecontrol.v1.AllocateQuotaResponse.class,
      methodType = io.grpc.MethodDescriptor.MethodType.UNARY)
  public static io.grpc.MethodDescriptor<
          com.google.api.servicecontrol.v1.AllocateQuotaRequest,
          com.google.api.servicecontrol.v1.AllocateQuotaResponse>
      getAllocateQuotaMethod() {
    io.grpc.MethodDescriptor<
            com.google.api.servicecontrol.v1.AllocateQuotaRequest,
            com.google.api.servicecontrol.v1.AllocateQuotaResponse>
        getAllocateQuotaMethod;
    if ((getAllocateQuotaMethod = QuotaControllerGrpc.getAllocateQuotaMethod) == null) {
      synchronized (QuotaControllerGrpc.class) {
        if ((getAllocateQuotaMethod = QuotaControllerGrpc.getAllocateQuotaMethod) == null) {
          QuotaControllerGrpc.getAllocateQuotaMethod =
              getAllocateQuotaMethod =
                  io.grpc.MethodDescriptor
                      .
                          newBuilder()
                      .setType(io.grpc.MethodDescriptor.MethodType.UNARY)
                      .setFullMethodName(generateFullMethodName(SERVICE_NAME, "AllocateQuota"))
                      .setSampledToLocalTracing(true)
                      .setRequestMarshaller(
                          io.grpc.protobuf.ProtoUtils.marshaller(
                              com.google.api.servicecontrol.v1.AllocateQuotaRequest
                                  .getDefaultInstance()))
                      .setResponseMarshaller(
                          io.grpc.protobuf.ProtoUtils.marshaller(
                              com.google.api.servicecontrol.v1.AllocateQuotaResponse
                                  .getDefaultInstance()))
                      .setSchemaDescriptor(
                          new QuotaControllerMethodDescriptorSupplier("AllocateQuota"))
                      .build();
        }
      }
    }
    return getAllocateQuotaMethod;
  }

  /** Creates a new async stub that supports all call types for the service */
  public static QuotaControllerStub newStub(io.grpc.Channel channel) {
    io.grpc.stub.AbstractStub.StubFactory factory =
        new io.grpc.stub.AbstractStub.StubFactory() {
          @java.lang.Override
          public QuotaControllerStub newStub(
              io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
            return new QuotaControllerStub(channel, callOptions);
          }
        };
    return QuotaControllerStub.newStub(factory, channel);
  }

  /**
   * Creates a new blocking-style stub that supports unary and streaming output calls on the service
   */
  public static QuotaControllerBlockingStub newBlockingStub(io.grpc.Channel channel) {
    io.grpc.stub.AbstractStub.StubFactory factory =
        new io.grpc.stub.AbstractStub.StubFactory() {
          @java.lang.Override
          public QuotaControllerBlockingStub newStub(
              io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
            return new QuotaControllerBlockingStub(channel, callOptions);
          }
        };
    return QuotaControllerBlockingStub.newStub(factory, channel);
  }

  /** Creates a new ListenableFuture-style stub that supports unary calls on the service */
  public static QuotaControllerFutureStub newFutureStub(io.grpc.Channel channel) {
    io.grpc.stub.AbstractStub.StubFactory factory =
        new io.grpc.stub.AbstractStub.StubFactory() {
          @java.lang.Override
          public QuotaControllerFutureStub newStub(
              io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
            return new QuotaControllerFutureStub(channel, callOptions);
          }
        };
    return QuotaControllerFutureStub.newStub(factory, channel);
  }

  /**
   *
   *
   *    * [Google Quota Control API](/service-control/overview)
   * Allows clients to allocate and release quota against a [managed
   * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
   * 
   */
  public interface AsyncService {

    /**
     *
     *
     *      * Attempts to allocate quota for the specified consumer. It should be called
     * before the operation is executed.
     * This method requires the `servicemanagement.services.quota`
     * permission on the specified service. For more information, see
     * [Cloud IAM](https://cloud.google.com/iam).
     * **NOTE:** The client **must** fail-open on server errors `INTERNAL`,
     * `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system
     * reliability, the server may inject these errors to prohibit any hard
     * dependency on the quota functionality.
     * 
     */
    default void allocateQuota(
        com.google.api.servicecontrol.v1.AllocateQuotaRequest request,
        io.grpc.stub.StreamObserver
            responseObserver) {
      io.grpc.stub.ServerCalls.asyncUnimplementedUnaryCall(
          getAllocateQuotaMethod(), responseObserver);
    }
  }

  /**
   * Base class for the server implementation of the service QuotaController.
   *
   *    * [Google Quota Control API](/service-control/overview)
   * Allows clients to allocate and release quota against a [managed
   * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
   * 
   */
  public abstract static class QuotaControllerImplBase
      implements io.grpc.BindableService, AsyncService {

    @java.lang.Override
    public final io.grpc.ServerServiceDefinition bindService() {
      return QuotaControllerGrpc.bindService(this);
    }
  }

  /**
   * A stub to allow clients to do asynchronous rpc calls to service QuotaController.
   *
   *    * [Google Quota Control API](/service-control/overview)
   * Allows clients to allocate and release quota against a [managed
   * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
   * 
   */
  public static final class QuotaControllerStub
      extends io.grpc.stub.AbstractAsyncStub {
    private QuotaControllerStub(io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
      super(channel, callOptions);
    }

    @java.lang.Override
    protected QuotaControllerStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
      return new QuotaControllerStub(channel, callOptions);
    }

    /**
     *
     *
     *      * Attempts to allocate quota for the specified consumer. It should be called
     * before the operation is executed.
     * This method requires the `servicemanagement.services.quota`
     * permission on the specified service. For more information, see
     * [Cloud IAM](https://cloud.google.com/iam).
     * **NOTE:** The client **must** fail-open on server errors `INTERNAL`,
     * `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system
     * reliability, the server may inject these errors to prohibit any hard
     * dependency on the quota functionality.
     * 
     */
    public void allocateQuota(
        com.google.api.servicecontrol.v1.AllocateQuotaRequest request,
        io.grpc.stub.StreamObserver
            responseObserver) {
      io.grpc.stub.ClientCalls.asyncUnaryCall(
          getChannel().newCall(getAllocateQuotaMethod(), getCallOptions()),
          request,
          responseObserver);
    }
  }

  /**
   * A stub to allow clients to do synchronous rpc calls to service QuotaController.
   *
   *    * [Google Quota Control API](/service-control/overview)
   * Allows clients to allocate and release quota against a [managed
   * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
   * 
   */
  public static final class QuotaControllerBlockingStub
      extends io.grpc.stub.AbstractBlockingStub {
    private QuotaControllerBlockingStub(io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
      super(channel, callOptions);
    }

    @java.lang.Override
    protected QuotaControllerBlockingStub build(
        io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
      return new QuotaControllerBlockingStub(channel, callOptions);
    }

    /**
     *
     *
     *      * Attempts to allocate quota for the specified consumer. It should be called
     * before the operation is executed.
     * This method requires the `servicemanagement.services.quota`
     * permission on the specified service. For more information, see
     * [Cloud IAM](https://cloud.google.com/iam).
     * **NOTE:** The client **must** fail-open on server errors `INTERNAL`,
     * `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system
     * reliability, the server may inject these errors to prohibit any hard
     * dependency on the quota functionality.
     * 
     */
    public com.google.api.servicecontrol.v1.AllocateQuotaResponse allocateQuota(
        com.google.api.servicecontrol.v1.AllocateQuotaRequest request) {
      return io.grpc.stub.ClientCalls.blockingUnaryCall(
          getChannel(), getAllocateQuotaMethod(), getCallOptions(), request);
    }
  }

  /**
   * A stub to allow clients to do ListenableFuture-style rpc calls to service QuotaController.
   *
   *    * [Google Quota Control API](/service-control/overview)
   * Allows clients to allocate and release quota against a [managed
   * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
   * 
   */
  public static final class QuotaControllerFutureStub
      extends io.grpc.stub.AbstractFutureStub {
    private QuotaControllerFutureStub(io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
      super(channel, callOptions);
    }

    @java.lang.Override
    protected QuotaControllerFutureStub build(
        io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
      return new QuotaControllerFutureStub(channel, callOptions);
    }

    /**
     *
     *
     *      * Attempts to allocate quota for the specified consumer. It should be called
     * before the operation is executed.
     * This method requires the `servicemanagement.services.quota`
     * permission on the specified service. For more information, see
     * [Cloud IAM](https://cloud.google.com/iam).
     * **NOTE:** The client **must** fail-open on server errors `INTERNAL`,
     * `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system
     * reliability, the server may inject these errors to prohibit any hard
     * dependency on the quota functionality.
     * 
     */
    public com.google.common.util.concurrent.ListenableFuture<
            com.google.api.servicecontrol.v1.AllocateQuotaResponse>
        allocateQuota(com.google.api.servicecontrol.v1.AllocateQuotaRequest request) {
      return io.grpc.stub.ClientCalls.futureUnaryCall(
          getChannel().newCall(getAllocateQuotaMethod(), getCallOptions()), request);
    }
  }

  private static final int METHODID_ALLOCATE_QUOTA = 0;

  private static final class MethodHandlers
      implements io.grpc.stub.ServerCalls.UnaryMethod,
          io.grpc.stub.ServerCalls.ServerStreamingMethod,
          io.grpc.stub.ServerCalls.ClientStreamingMethod,
          io.grpc.stub.ServerCalls.BidiStreamingMethod {
    private final AsyncService serviceImpl;
    private final int methodId;

    MethodHandlers(AsyncService serviceImpl, int methodId) {
      this.serviceImpl = serviceImpl;
      this.methodId = methodId;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("unchecked")
    public void invoke(Req request, io.grpc.stub.StreamObserver responseObserver) {
      switch (methodId) {
        case METHODID_ALLOCATE_QUOTA:
          serviceImpl.allocateQuota(
              (com.google.api.servicecontrol.v1.AllocateQuotaRequest) request,
              (io.grpc.stub.StreamObserver)
                  responseObserver);
          break;
        default:
          throw new AssertionError();
      }
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("unchecked")
    public io.grpc.stub.StreamObserver invoke(
        io.grpc.stub.StreamObserver responseObserver) {
      switch (methodId) {
        default:
          throw new AssertionError();
      }
    }
  }

  public static final io.grpc.ServerServiceDefinition bindService(AsyncService service) {
    return io.grpc.ServerServiceDefinition.builder(getServiceDescriptor())
        .addMethod(
            getAllocateQuotaMethod(),
            io.grpc.stub.ServerCalls.asyncUnaryCall(
                new MethodHandlers<
                    com.google.api.servicecontrol.v1.AllocateQuotaRequest,
                    com.google.api.servicecontrol.v1.AllocateQuotaResponse>(
                    service, METHODID_ALLOCATE_QUOTA)))
        .build();
  }

  private abstract static class QuotaControllerBaseDescriptorSupplier
      implements io.grpc.protobuf.ProtoFileDescriptorSupplier,
          io.grpc.protobuf.ProtoServiceDescriptorSupplier {
    QuotaControllerBaseDescriptorSupplier() {}

    @java.lang.Override
    public com.google.protobuf.Descriptors.FileDescriptor getFileDescriptor() {
      return com.google.api.servicecontrol.v1.QuotaControllerProto.getDescriptor();
    }

    @java.lang.Override
    public com.google.protobuf.Descriptors.ServiceDescriptor getServiceDescriptor() {
      return getFileDescriptor().findServiceByName("QuotaController");
    }
  }

  private static final class QuotaControllerFileDescriptorSupplier
      extends QuotaControllerBaseDescriptorSupplier {
    QuotaControllerFileDescriptorSupplier() {}
  }

  private static final class QuotaControllerMethodDescriptorSupplier
      extends QuotaControllerBaseDescriptorSupplier
      implements io.grpc.protobuf.ProtoMethodDescriptorSupplier {
    private final java.lang.String methodName;

    QuotaControllerMethodDescriptorSupplier(java.lang.String methodName) {
      this.methodName = methodName;
    }

    @java.lang.Override
    public com.google.protobuf.Descriptors.MethodDescriptor getMethodDescriptor() {
      return getServiceDescriptor().findMethodByName(methodName);
    }
  }

  private static volatile io.grpc.ServiceDescriptor serviceDescriptor;

  public static io.grpc.ServiceDescriptor getServiceDescriptor() {
    io.grpc.ServiceDescriptor result = serviceDescriptor;
    if (result == null) {
      synchronized (QuotaControllerGrpc.class) {
        result = serviceDescriptor;
        if (result == null) {
          serviceDescriptor =
              result =
                  io.grpc.ServiceDescriptor.newBuilder(SERVICE_NAME)
                      .setSchemaDescriptor(new QuotaControllerFileDescriptorSupplier())
                      .addMethod(getAllocateQuotaMethod())
                      .build();
        }
      }
    }
    return result;
  }
}