Class ServiceControllerGrpc.ServiceControllerFutureStub (1.27.0)

public static final class ServiceControllerGrpc.ServiceControllerFutureStub extends AbstractFutureStub<ServiceControllerGrpc.ServiceControllerFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service ServiceController.

Google Service Control API Lets clients check and report operations against a managed service.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ServiceControllerGrpc.ServiceControllerFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected ServiceControllerGrpc.ServiceControllerFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ServiceControllerGrpc.ServiceControllerFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

check(CheckRequest request)

public ListenableFuture<CheckResponse> check(CheckRequest request)

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 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.

Parameter
NameDescription
requestCheckRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CheckResponse>

report(ReportRequest request)

public ListenableFuture<ReportResponse> report(ReportRequest request)

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 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.

Parameter
NameDescription
requestReportRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ReportResponse>