com.google.api.servicecontrol.v1.QuotaControllerClient Maven / Gradle / Ivy
Show all versions of google-cloud-service-control Show documentation
/*
* 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 com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.servicecontrol.v1.stub.QuotaControllerStub;
import com.google.api.servicecontrol.v1.stub.QuotaControllerStubSettings;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: [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).
*
*
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:
*
*
{@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);
* }
* }
*
* 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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* AllocateQuota
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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* allocateQuota(AllocateQuotaRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* allocateQuotaCallable()
*
*
*
*
*
* 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:
*
*
{@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
* QuotaControllerSettings quotaControllerSettings =
* QuotaControllerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* QuotaControllerClient quotaControllerClient =
* QuotaControllerClient.create(quotaControllerSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* QuotaControllerSettings quotaControllerSettings =
* QuotaControllerSettings.newHttpJsonBuilder().build();
* QuotaControllerClient quotaControllerClient =
* QuotaControllerClient.create(quotaControllerSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class QuotaControllerClient implements BackgroundResource {
private final QuotaControllerSettings settings;
private final QuotaControllerStub stub;
/** Constructs an instance of QuotaControllerClient with default settings. */
public static final QuotaControllerClient create() throws IOException {
return create(QuotaControllerSettings.newBuilder().build());
}
/**
* 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.
*/
public static final QuotaControllerClient create(QuotaControllerSettings settings)
throws IOException {
return new QuotaControllerClient(settings);
}
/**
* Constructs an instance of QuotaControllerClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(QuotaControllerSettings).
*/
public static final QuotaControllerClient create(QuotaControllerStub stub) {
return new QuotaControllerClient(stub);
}
/**
* 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.
*/
protected QuotaControllerClient(QuotaControllerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((QuotaControllerStubSettings) settings.getStubSettings()).createStub();
}
protected QuotaControllerClient(QuotaControllerStub stub) {
this.settings = null;
this.stub = stub;
}
public final QuotaControllerSettings getSettings() {
return settings;
}
public QuotaControllerStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AllocateQuotaResponse allocateQuota(AllocateQuotaRequest request) {
return allocateQuotaCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.
*
*
Sample code:
*
*
{@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 future =
* quotaControllerClient.allocateQuotaCallable().futureCall(request);
* // Do something.
* AllocateQuotaResponse response = future.get();
* }
* }
*/
public final UnaryCallable allocateQuotaCallable() {
return stub.allocateQuotaCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}