Class QuotaControllerClient (1.11.0) 

public class QuotaControllerClient implements BackgroundResource

Service Description: Google Quota Control API

Allows clients to allocate and release quota against a managed service.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (QuotaControllerClient quotaControllerClient = QuotaControllerClient.create()) {
   AllocateQuotaRequest request =
       AllocateQuotaRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .setAllocateOperation(QuotaOperation.newBuilder().build())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   AllocateQuotaResponse response = quotaControllerClient.allocateQuota(request);
 }

Note: close() needs to be called on the QuotaControllerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of QuotaControllerSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 QuotaControllerSettings quotaControllerSettings =
     QuotaControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 QuotaControllerClient quotaControllerClient =
     QuotaControllerClient.create(quotaControllerSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 QuotaControllerSettings quotaControllerSettings =
     QuotaControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 QuotaControllerClient quotaControllerClient =
     QuotaControllerClient.create(quotaControllerSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 QuotaControllerSettings quotaControllerSettings =
     QuotaControllerSettings.newHttpJsonBuilder().build();
 QuotaControllerClient quotaControllerClient =
     QuotaControllerClient.create(quotaControllerSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > QuotaControllerClient

Implements

BackgroundResource

Static Methods

create()

public static final QuotaControllerClient create()

Constructs an instance of QuotaControllerClient with default settings.

Returns
TypeDescription
QuotaControllerClient
Exceptions
TypeDescription
IOException

create(QuotaControllerSettings settings)

public static final QuotaControllerClient create(QuotaControllerSettings settings)

Constructs an instance of QuotaControllerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsQuotaControllerSettings
Returns
TypeDescription
QuotaControllerClient
Exceptions
TypeDescription
IOException

create(QuotaControllerStub stub)

public static final QuotaControllerClient create(QuotaControllerStub stub)

Constructs an instance of QuotaControllerClient, using the given stub for making calls. This is for advanced usage - prefer using create(QuotaControllerSettings).

Parameter
NameDescription
stubQuotaControllerStub
Returns
TypeDescription
QuotaControllerClient

Constructors

QuotaControllerClient(QuotaControllerSettings settings)

protected QuotaControllerClient(QuotaControllerSettings settings)

Constructs an instance of QuotaControllerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsQuotaControllerSettings

QuotaControllerClient(QuotaControllerStub stub)

protected QuotaControllerClient(QuotaControllerStub stub)
Parameter
NameDescription
stubQuotaControllerStub

Methods

allocateQuota(AllocateQuotaRequest request)

public final AllocateQuotaResponse allocateQuota(AllocateQuotaRequest request)

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.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (QuotaControllerClient quotaControllerClient = QuotaControllerClient.create()) {
   AllocateQuotaRequest request =
       AllocateQuotaRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .setAllocateOperation(QuotaOperation.newBuilder().build())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   AllocateQuotaResponse response = quotaControllerClient.allocateQuota(request);
 }
Parameter
NameDescription
requestAllocateQuotaRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AllocateQuotaResponse

allocateQuotaCallable()

public final UnaryCallable<AllocateQuotaRequest,AllocateQuotaResponse> allocateQuotaCallable()

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.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (QuotaControllerClient quotaControllerClient = QuotaControllerClient.create()) {
   AllocateQuotaRequest request =
       AllocateQuotaRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .setAllocateOperation(QuotaOperation.newBuilder().build())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   ApiFuture<AllocateQuotaResponse> future =
       quotaControllerClient.allocateQuotaCallable().futureCall(request);
   // Do something.
   AllocateQuotaResponse response = future.get();
 }
Returns
TypeDescription
UnaryCallable<AllocateQuotaRequest,AllocateQuotaResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final QuotaControllerSettings getSettings()
Returns
TypeDescription
QuotaControllerSettings

getStub()

public QuotaControllerStub getStub()
Returns
TypeDescription
QuotaControllerStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()