com.google.api.control

Class Client

java.lang.Object

com.google.api.control.Client

public class Client
extends java.lang.Object

Client is a package-level facade that encapsulates all service control functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.Builder Builder provide structure to the construction of a Client

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.api.control.Client.SchedulerFactory	DEFAULT_SCHEDULER_FACTORY
static int	DO_NOT_LOG_STATS

Constructor Summary

Constructors

Constructor and Description
Client(java.lang.String serviceName, CheckAggregationOptions checkOptions, ReportAggregationOptions reportOptions, QuotaAggregationOptions quotaOptions, com.google.api.services.servicecontrol.v1.ServiceControl transport, java.util.concurrent.ThreadFactory threads, com.google.api.control.Client.SchedulerFactory schedulers, int statsLogFrequency, com.google.common.base.Ticker ticker)

Method Summary

Modifier and Type	Method and Description
com.google.api.servicecontrol.v1.AllocateQuotaResponse	allocateQuota(com.google.api.servicecontrol.v1.AllocateQuotaRequest req)
com.google.api.servicecontrol.v1.CheckResponse	check(com.google.api.servicecontrol.v1.CheckRequest req) Process a check request.
void	report(com.google.api.servicecontrol.v1.ReportRequest req) Process a report request.
void	start() Starts processing.
void	stop() Stops processing.

Methods inherited from class java.lang.Object

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

Field Detail

DO_NOT_LOG_STATS

public static final int DO_NOT_LOG_STATS

See Also:

Constant Field Values

DEFAULT_SCHEDULER_FACTORY

public static final com.google.api.control.Client.SchedulerFactory DEFAULT_SCHEDULER_FACTORY

Constructor Detail

Client

public Client(java.lang.String serviceName,
              CheckAggregationOptions checkOptions,
              ReportAggregationOptions reportOptions,
              QuotaAggregationOptions quotaOptions,
              com.google.api.services.servicecontrol.v1.ServiceControl transport,
              java.util.concurrent.ThreadFactory threads,
              com.google.api.control.Client.SchedulerFactory schedulers,
              int statsLogFrequency,
              @Nullable
              com.google.common.base.Ticker ticker)

Method Detail

start

public void start()

Starts processing. Calling this method starts the thread that regularly flushes all enabled caches. enables the other methods on the instance to be called successfully I.e, even when the configuration disables aggregation, it is invalid to access the other methods of an instance until ``start`` is called - Calls to other public methods will fail with an IllegalStateError.

stop

public void stop()

Stops processing. Does not block waiting for processing to stop, but after this called, the scheduler thread if it's active will come to a close

check

@Nullable
public com.google.api.servicecontrol.v1.CheckResponse check(com.google.api.servicecontrol.v1.CheckRequest req)

Process a check request. The req is first passed to the CheckAggregator. If there is a valid cached response, that is returned, otherwise a response is obtained from the transport.

Parameters:

req - a CheckRequest

Returns:

a CheckResponse or null if none was cached and there was a transport failure

allocateQuota

public com.google.api.servicecontrol.v1.AllocateQuotaResponse allocateQuota(com.google.api.servicecontrol.v1.AllocateQuotaRequest req)

report

public void report(com.google.api.servicecontrol.v1.ReportRequest req)

Process a report request. The req is first passed to the ReportAggregator. It will either be aggregated with prior requests or sent immediately

Parameters:

req - a ReportRequest