Package com.google.api.servicecontrol.v1

Class ServiceControllerGrpc.ServiceControllerStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractAsyncStub<ServiceControllerGrpc.ServiceControllerStub>
com.google.api.servicecontrol.v1.ServiceControllerGrpc.ServiceControllerStub
Enclosing class:
ServiceControllerGrpc
public static final class ServiceControllerGrpc.ServiceControllerStub extends io.grpc.stub.AbstractAsyncStub<ServiceControllerGrpc.ServiceControllerStub>
A stub to allow clients to do asynchronous rpc calls to service ServiceController. 
 [Google Service Control API](/service-control/overview)
 Lets clients check and report operations against a [managed
 service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).

  • 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 ServiceControllerGrpc.ServiceControllerStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    void
    check(CheckRequest request, io.grpc.stub.StreamObserver<CheckResponse> responseObserver)
    Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies.
    void
    report(ReportRequest request, io.grpc.stub.StreamObserver<ReportResponse> responseObserver)
    Reports operation results to Google Service Control, such as logs and metrics.

    Methods inherited from class io.grpc.stub.AbstractAsyncStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • build

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

    • check

      public void check(CheckRequest request, io.grpc.stub.StreamObserver<CheckResponse> responseObserver)
       Checks whether an operation on a service should be allowed to proceed
 based on the configuration of the service and related policies. It must be
 called before the operation is executed.
 If feasible, the client should cache the check results and reuse them for
 60 seconds. In case of any server errors, the client should rely on the
 cached results for much longer time to avoid outage.
 WARNING: There is general 60s delay for the configuration and policy
 propagation, therefore callers MUST NOT depend on the `Check` method having
 the latest policy information.
 NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has
 the size limit (wire-format byte size) of 1MB.
 This method requires the `servicemanagement.services.check` permission
 on the specified service. For more information, see
 [Cloud IAM](https://cloud.google.com/iam).

    • report

      public void report(ReportRequest request, io.grpc.stub.StreamObserver<ReportResponse> responseObserver)
       Reports operation results to Google Service Control, such as logs and
 metrics. It should be called after an operation is completed.
 If feasible, the client should aggregate reporting data for up to 5
 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to
 reduce data loss during client crashes. Clients should carefully choose
 the aggregation time window to avoid data loss risk more than 0.01%
 for business and compliance reasons.
 NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has
 the size limit (wire-format byte size) of 1MB.
 This method requires the `servicemanagement.services.report` permission
 on the specified service. For more information, see
 [Google Cloud IAM](https://cloud.google.com/iam).