com.google.api.cloudquotas.v1

Class CloudQuotasClient

java.lang.Object

com.google.api.cloudquotas.v1.CloudQuotasClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class CloudQuotasClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The Cloud Quotas API is an infrastructure service for Google Cloud that lets service consumers list and manage their resource usage limits.

- List/Get the metadata and current status of the quotas for a service. - Create/Update quota preferencess that declare the preferred quota values. - Check the status of a quota preference request. - List/Get pending and historical quota preference.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   QuotaInfoName name =
       QuotaInfoName.ofProjectLocationServiceQuotaInfoName(
           "[PROJECT]", "[LOCATION]", "[SERVICE]", "[QUOTA_INFO]");
   QuotaInfo response = cloudQuotasClient.getQuotaInfo(name);
 }
 

Note: close() needs to be called on the CloudQuotasClient 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
ListQuotaInfos	Lists QuotaInfos of all quotas for a given project, folder or organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listQuotaInfos(ListQuotaInfosRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listQuotaInfos(ServiceName parent) listQuotaInfos(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listQuotaInfosPagedCallable() listQuotaInfosCallable()
GetQuotaInfo	Retrieve the QuotaInfo of a quota for a project, folder or organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getQuotaInfo(GetQuotaInfoRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getQuotaInfo(QuotaInfoName name) getQuotaInfo(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getQuotaInfoCallable()
ListQuotaPreferences	Lists QuotaPreferences in a given project, folder or organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listQuotaPreferences(ListQuotaPreferencesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listQuotaPreferences(LocationName parent) listQuotaPreferences(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listQuotaPreferencesPagedCallable() listQuotaPreferencesCallable()
GetQuotaPreference	Gets details of a single QuotaPreference.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getQuotaPreference(GetQuotaPreferenceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getQuotaPreference(QuotaPreferenceName name) getQuotaPreference(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getQuotaPreferenceCallable()
CreateQuotaPreference	Creates a new QuotaPreference that declares the desired value for a quota.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createQuotaPreference(CreateQuotaPreferenceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createQuotaPreference(LocationName parent, QuotaPreference quotaPreference) createQuotaPreference(String parent, QuotaPreference quotaPreference) createQuotaPreference(LocationName parent, QuotaPreference quotaPreference, String quotaPreferenceId) createQuotaPreference(String parent, QuotaPreference quotaPreference, String quotaPreferenceId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createQuotaPreferenceCallable()
UpdateQuotaPreference	Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateQuotaPreference(UpdateQuotaPreferenceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateQuotaPreference(QuotaPreference quotaPreference, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateQuotaPreferenceCallable()

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 CloudQuotasSettings 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
 CloudQuotasSettings cloudQuotasSettings =
     CloudQuotasSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create(cloudQuotasSettings);
 

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
 CloudQuotasSettings cloudQuotasSettings =
     CloudQuotasSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create(cloudQuotasSettings);
 

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
 CloudQuotasSettings cloudQuotasSettings = CloudQuotasSettings.newHttpJsonBuilder().build();
 CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create(cloudQuotasSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudQuotasClient.ListQuotaInfosFixedSizeCollection
static class	CloudQuotasClient.ListQuotaInfosPage
static class	CloudQuotasClient.ListQuotaInfosPagedResponse
static class	CloudQuotasClient.ListQuotaPreferencesFixedSizeCollection
static class	CloudQuotasClient.ListQuotaPreferencesPage
static class	CloudQuotasClient.ListQuotaPreferencesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudQuotasClient(CloudQuotasSettings settings) Constructs an instance of CloudQuotasClient, using the given settings.
protected	CloudQuotasClient(CloudQuotasStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static CloudQuotasClient	create() Constructs an instance of CloudQuotasClient with default settings.
static CloudQuotasClient	create(CloudQuotasSettings settings) Constructs an instance of CloudQuotasClient, using the given settings.
static CloudQuotasClient	create(CloudQuotasStub stub) Constructs an instance of CloudQuotasClient, using the given stub for making calls.
QuotaPreference	createQuotaPreference(CreateQuotaPreferenceRequest request) Creates a new QuotaPreference that declares the desired value for a quota.
QuotaPreference	createQuotaPreference(LocationName parent, QuotaPreference quotaPreference) Creates a new QuotaPreference that declares the desired value for a quota.
QuotaPreference	createQuotaPreference(LocationName parent, QuotaPreference quotaPreference, String quotaPreferenceId) Creates a new QuotaPreference that declares the desired value for a quota.
QuotaPreference	createQuotaPreference(String parent, QuotaPreference quotaPreference) Creates a new QuotaPreference that declares the desired value for a quota.
QuotaPreference	createQuotaPreference(String parent, QuotaPreference quotaPreference, String quotaPreferenceId) Creates a new QuotaPreference that declares the desired value for a quota.
com.google.api.gax.rpc.UnaryCallable<CreateQuotaPreferenceRequest,QuotaPreference>	createQuotaPreferenceCallable() Creates a new QuotaPreference that declares the desired value for a quota.
QuotaInfo	getQuotaInfo(GetQuotaInfoRequest request) Retrieve the QuotaInfo of a quota for a project, folder or organization.
QuotaInfo	getQuotaInfo(QuotaInfoName name) Retrieve the QuotaInfo of a quota for a project, folder or organization.
QuotaInfo	getQuotaInfo(String name) Retrieve the QuotaInfo of a quota for a project, folder or organization.
com.google.api.gax.rpc.UnaryCallable<GetQuotaInfoRequest,QuotaInfo>	getQuotaInfoCallable() Retrieve the QuotaInfo of a quota for a project, folder or organization.
QuotaPreference	getQuotaPreference(GetQuotaPreferenceRequest request) Gets details of a single QuotaPreference.
QuotaPreference	getQuotaPreference(QuotaPreferenceName name) Gets details of a single QuotaPreference.
QuotaPreference	getQuotaPreference(String name) Gets details of a single QuotaPreference.
com.google.api.gax.rpc.UnaryCallable<GetQuotaPreferenceRequest,QuotaPreference>	getQuotaPreferenceCallable() Gets details of a single QuotaPreference.
CloudQuotasSettings	getSettings()
CloudQuotasStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
CloudQuotasClient.ListQuotaInfosPagedResponse	listQuotaInfos(ListQuotaInfosRequest request) Lists QuotaInfos of all quotas for a given project, folder or organization.
CloudQuotasClient.ListQuotaInfosPagedResponse	listQuotaInfos(ServiceName parent) Lists QuotaInfos of all quotas for a given project, folder or organization.
CloudQuotasClient.ListQuotaInfosPagedResponse	listQuotaInfos(String parent) Lists QuotaInfos of all quotas for a given project, folder or organization.
com.google.api.gax.rpc.UnaryCallable<ListQuotaInfosRequest,ListQuotaInfosResponse>	listQuotaInfosCallable() Lists QuotaInfos of all quotas for a given project, folder or organization.
com.google.api.gax.rpc.UnaryCallable<ListQuotaInfosRequest,CloudQuotasClient.ListQuotaInfosPagedResponse>	listQuotaInfosPagedCallable() Lists QuotaInfos of all quotas for a given project, folder or organization.
CloudQuotasClient.ListQuotaPreferencesPagedResponse	listQuotaPreferences(ListQuotaPreferencesRequest request) Lists QuotaPreferences in a given project, folder or organization.
CloudQuotasClient.ListQuotaPreferencesPagedResponse	listQuotaPreferences(LocationName parent) Lists QuotaPreferences in a given project, folder or organization.
CloudQuotasClient.ListQuotaPreferencesPagedResponse	listQuotaPreferences(String parent) Lists QuotaPreferences in a given project, folder or organization.
com.google.api.gax.rpc.UnaryCallable<ListQuotaPreferencesRequest,ListQuotaPreferencesResponse>	listQuotaPreferencesCallable() Lists QuotaPreferences in a given project, folder or organization.
com.google.api.gax.rpc.UnaryCallable<ListQuotaPreferencesRequest,CloudQuotasClient.ListQuotaPreferencesPagedResponse>	listQuotaPreferencesPagedCallable() Lists QuotaPreferences in a given project, folder or organization.
void	shutdown()
void	shutdownNow()
QuotaPreference	updateQuotaPreference(QuotaPreference quotaPreference, com.google.protobuf.FieldMask updateMask) Updates the parameters of a single QuotaPreference.
QuotaPreference	updateQuotaPreference(UpdateQuotaPreferenceRequest request) Updates the parameters of a single QuotaPreference.
com.google.api.gax.rpc.UnaryCallable<UpdateQuotaPreferenceRequest,QuotaPreference>	updateQuotaPreferenceCallable() Updates the parameters of a single QuotaPreference.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudQuotasClient

protected CloudQuotasClient(CloudQuotasSettings settings)
                     throws IOException

Constructs an instance of CloudQuotasClient, 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.

Throws:

IOException

CloudQuotasClient

protected CloudQuotasClient(CloudQuotasStub stub)

Method Detail

create

public static final CloudQuotasClient create()
                                      throws IOException

Constructs an instance of CloudQuotasClient with default settings.

Throws:

IOException

create

public static final CloudQuotasClient create(CloudQuotasSettings settings)
                                      throws IOException

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

Throws:

IOException

create

public static final CloudQuotasClient create(CloudQuotasStub stub)

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

getSettings

public final CloudQuotasSettings getSettings()

getStub

public CloudQuotasStub getStub()

listQuotaInfos

public final CloudQuotasClient.ListQuotaInfosPagedResponse listQuotaInfos(ServiceName parent)

Lists QuotaInfos of all quotas for a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ServiceName parent =
       ServiceName.ofProjectLocationServiceName("[PROJECT]", "[LOCATION]", "[SERVICE]");
   for (QuotaInfo element : cloudQuotasClient.listQuotaInfos(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Parent value of QuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed.

Example names: `projects/123/locations/global/services/compute.googleapis.com` `folders/234/locations/global/services/compute.googleapis.com` `organizations/345/locations/global/services/compute.googleapis.com`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listQuotaInfos

public final CloudQuotasClient.ListQuotaInfosPagedResponse listQuotaInfos(String parent)

Lists QuotaInfos of all quotas for a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   String parent =
       ServiceName.ofProjectLocationServiceName("[PROJECT]", "[LOCATION]", "[SERVICE]")
           .toString();
   for (QuotaInfo element : cloudQuotasClient.listQuotaInfos(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Parent value of QuotaInfo resources. Listing across different resource containers (such as 'projects/-') is not allowed.

Example names: `projects/123/locations/global/services/compute.googleapis.com` `folders/234/locations/global/services/compute.googleapis.com` `organizations/345/locations/global/services/compute.googleapis.com`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listQuotaInfos

public final CloudQuotasClient.ListQuotaInfosPagedResponse listQuotaInfos(ListQuotaInfosRequest request)

Lists QuotaInfos of all quotas for a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ListQuotaInfosRequest request =
       ListQuotaInfosRequest.newBuilder()
           .setParent(
               ServiceName.ofProjectLocationServiceName("[PROJECT]", "[LOCATION]", "[SERVICE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (QuotaInfo element : cloudQuotasClient.listQuotaInfos(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

listQuotaInfosPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListQuotaInfosRequest,CloudQuotasClient.ListQuotaInfosPagedResponse> listQuotaInfosPagedCallable()

Lists QuotaInfos of all quotas for a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ListQuotaInfosRequest request =
       ListQuotaInfosRequest.newBuilder()
           .setParent(
               ServiceName.ofProjectLocationServiceName("[PROJECT]", "[LOCATION]", "[SERVICE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<QuotaInfo> future =
       cloudQuotasClient.listQuotaInfosPagedCallable().futureCall(request);
   // Do something.
   for (QuotaInfo element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listQuotaInfosCallable

public final com.google.api.gax.rpc.UnaryCallable<ListQuotaInfosRequest,ListQuotaInfosResponse> listQuotaInfosCallable()

Lists QuotaInfos of all quotas for a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ListQuotaInfosRequest request =
       ListQuotaInfosRequest.newBuilder()
           .setParent(
               ServiceName.ofProjectLocationServiceName("[PROJECT]", "[LOCATION]", "[SERVICE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListQuotaInfosResponse response = cloudQuotasClient.listQuotaInfosCallable().call(request);
     for (QuotaInfo element : response.getQuotaInfosList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getQuotaInfo

public final QuotaInfo getQuotaInfo(QuotaInfoName name)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   QuotaInfoName name =
       QuotaInfoName.ofProjectLocationServiceQuotaInfoName(
           "[PROJECT]", "[LOCATION]", "[SERVICE]", "[QUOTA_INFO]");
   QuotaInfo response = cloudQuotasClient.getQuotaInfo(name);
 }
 

Parameters:

name - Required. The resource name of the quota info.

An example name: `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getQuotaInfo

public final QuotaInfo getQuotaInfo(String name)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   String name =
       QuotaInfoName.ofProjectLocationServiceQuotaInfoName(
               "[PROJECT]", "[LOCATION]", "[SERVICE]", "[QUOTA_INFO]")
           .toString();
   QuotaInfo response = cloudQuotasClient.getQuotaInfo(name);
 }
 

Parameters:

name - Required. The resource name of the quota info.

An example name: `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getQuotaInfo

public final QuotaInfo getQuotaInfo(GetQuotaInfoRequest request)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   GetQuotaInfoRequest request =
       GetQuotaInfoRequest.newBuilder()
           .setName(
               QuotaInfoName.ofProjectLocationServiceQuotaInfoName(
                       "[PROJECT]", "[LOCATION]", "[SERVICE]", "[QUOTA_INFO]")
                   .toString())
           .build();
   QuotaInfo response = cloudQuotasClient.getQuotaInfo(request);
 }
 

Parameters:

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

getQuotaInfoCallable

public final com.google.api.gax.rpc.UnaryCallable<GetQuotaInfoRequest,QuotaInfo> getQuotaInfoCallable()

Retrieve the QuotaInfo of a quota for a project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   GetQuotaInfoRequest request =
       GetQuotaInfoRequest.newBuilder()
           .setName(
               QuotaInfoName.ofProjectLocationServiceQuotaInfoName(
                       "[PROJECT]", "[LOCATION]", "[SERVICE]", "[QUOTA_INFO]")
                   .toString())
           .build();
   ApiFuture<QuotaInfo> future = cloudQuotasClient.getQuotaInfoCallable().futureCall(request);
   // Do something.
   QuotaInfo response = future.get();
 }
 

listQuotaPreferences

public final CloudQuotasClient.ListQuotaPreferencesPagedResponse listQuotaPreferences(LocationName parent)

Lists QuotaPreferences in a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   LocationName parent = LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   for (QuotaPreference element : cloudQuotasClient.listQuotaPreferences(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed.

When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container.

Example parents: `projects/123/locations/global`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listQuotaPreferences

public final CloudQuotasClient.ListQuotaPreferencesPagedResponse listQuotaPreferences(String parent)

Lists QuotaPreferences in a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   String parent = LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString();
   for (QuotaPreference element : cloudQuotasClient.listQuotaPreferences(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Parent value of QuotaPreference resources. Listing across different resource containers (such as 'projects/-') is not allowed.

When the value starts with 'folders' or 'organizations', it lists the QuotaPreferences for org quotas in the container. It does not list the QuotaPreferences in the descendant projects of the container.

Example parents: `projects/123/locations/global`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listQuotaPreferences

public final CloudQuotasClient.ListQuotaPreferencesPagedResponse listQuotaPreferences(ListQuotaPreferencesRequest request)

Lists QuotaPreferences in a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ListQuotaPreferencesRequest request =
       ListQuotaPreferencesRequest.newBuilder()
           .setParent(LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (QuotaPreference element : cloudQuotasClient.listQuotaPreferences(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

listQuotaPreferencesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListQuotaPreferencesRequest,CloudQuotasClient.ListQuotaPreferencesPagedResponse> listQuotaPreferencesPagedCallable()

Lists QuotaPreferences in a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ListQuotaPreferencesRequest request =
       ListQuotaPreferencesRequest.newBuilder()
           .setParent(LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<QuotaPreference> future =
       cloudQuotasClient.listQuotaPreferencesPagedCallable().futureCall(request);
   // Do something.
   for (QuotaPreference element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listQuotaPreferencesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListQuotaPreferencesRequest,ListQuotaPreferencesResponse> listQuotaPreferencesCallable()

Lists QuotaPreferences in a given project, folder or organization.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   ListQuotaPreferencesRequest request =
       ListQuotaPreferencesRequest.newBuilder()
           .setParent(LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListQuotaPreferencesResponse response =
         cloudQuotasClient.listQuotaPreferencesCallable().call(request);
     for (QuotaPreference element : response.getQuotaPreferencesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getQuotaPreference

public final QuotaPreference getQuotaPreference(QuotaPreferenceName name)

Gets details of a single QuotaPreference.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   QuotaPreferenceName name =
       QuotaPreferenceName.ofProjectLocationQuotaPreferenceName(
           "[PROJECT]", "[LOCATION]", "[QUOTA_PREFERENCE]");
   QuotaPreference response = cloudQuotasClient.getQuotaPreference(name);
 }
 

Parameters:

name - Required. Name of the resource

Example name: `projects/123/locations/global/quota_preferences/my-config-for-us-east1`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getQuotaPreference

public final QuotaPreference getQuotaPreference(String name)

Gets details of a single QuotaPreference.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   String name =
       QuotaPreferenceName.ofProjectLocationQuotaPreferenceName(
               "[PROJECT]", "[LOCATION]", "[QUOTA_PREFERENCE]")
           .toString();
   QuotaPreference response = cloudQuotasClient.getQuotaPreference(name);
 }
 

Parameters:

name - Required. Name of the resource

Example name: `projects/123/locations/global/quota_preferences/my-config-for-us-east1`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getQuotaPreference

public final QuotaPreference getQuotaPreference(GetQuotaPreferenceRequest request)

Gets details of a single QuotaPreference.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   GetQuotaPreferenceRequest request =
       GetQuotaPreferenceRequest.newBuilder()
           .setName(
               QuotaPreferenceName.ofProjectLocationQuotaPreferenceName(
                       "[PROJECT]", "[LOCATION]", "[QUOTA_PREFERENCE]")
                   .toString())
           .build();
   QuotaPreference response = cloudQuotasClient.getQuotaPreference(request);
 }
 

Parameters:

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

getQuotaPreferenceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetQuotaPreferenceRequest,QuotaPreference> getQuotaPreferenceCallable()

Gets details of a single QuotaPreference.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   GetQuotaPreferenceRequest request =
       GetQuotaPreferenceRequest.newBuilder()
           .setName(
               QuotaPreferenceName.ofProjectLocationQuotaPreferenceName(
                       "[PROJECT]", "[LOCATION]", "[QUOTA_PREFERENCE]")
                   .toString())
           .build();
   ApiFuture<QuotaPreference> future =
       cloudQuotasClient.getQuotaPreferenceCallable().futureCall(request);
   // Do something.
   QuotaPreference response = future.get();
 }
 

createQuotaPreference

public final QuotaPreference createQuotaPreference(LocationName parent,
                                                   QuotaPreference quotaPreference)

Creates a new QuotaPreference that declares the desired value for a quota.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   LocationName parent = LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   QuotaPreference quotaPreference = QuotaPreference.newBuilder().build();
   QuotaPreference response = cloudQuotasClient.createQuotaPreference(parent, quotaPreference);
 }
 

Parameters:

parent - Required. Value for parent.

Example: `projects/123/locations/global`

quotaPreference - Required. The resource being created

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createQuotaPreference

public final QuotaPreference createQuotaPreference(String parent,
                                                   QuotaPreference quotaPreference)

Creates a new QuotaPreference that declares the desired value for a quota.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   String parent = LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString();
   QuotaPreference quotaPreference = QuotaPreference.newBuilder().build();
   QuotaPreference response = cloudQuotasClient.createQuotaPreference(parent, quotaPreference);
 }
 

Parameters:

parent - Required. Value for parent.

Example: `projects/123/locations/global`

quotaPreference - Required. The resource being created

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createQuotaPreference

public final QuotaPreference createQuotaPreference(LocationName parent,
                                                   QuotaPreference quotaPreference,
                                                   String quotaPreferenceId)

Creates a new QuotaPreference that declares the desired value for a quota.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   LocationName parent = LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   QuotaPreference quotaPreference = QuotaPreference.newBuilder().build();
   String quotaPreferenceId = "quotaPreferenceId-948332050";
   QuotaPreference response =
       cloudQuotasClient.createQuotaPreference(parent, quotaPreference, quotaPreferenceId);
 }
 

Parameters:

parent - Required. Value for parent.

Example: `projects/123/locations/global`

quotaPreference - Required. The resource being created

quotaPreferenceId - Optional. Id of the requesting object, must be unique under its parent. If client does not set this field, the service will generate one.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createQuotaPreference

public final QuotaPreference createQuotaPreference(String parent,
                                                   QuotaPreference quotaPreference,
                                                   String quotaPreferenceId)

Creates a new QuotaPreference that declares the desired value for a quota.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   String parent = LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString();
   QuotaPreference quotaPreference = QuotaPreference.newBuilder().build();
   String quotaPreferenceId = "quotaPreferenceId-948332050";
   QuotaPreference response =
       cloudQuotasClient.createQuotaPreference(parent, quotaPreference, quotaPreferenceId);
 }
 

Parameters:

parent - Required. Value for parent.

Example: `projects/123/locations/global`

quotaPreference - Required. The resource being created

quotaPreferenceId - Optional. Id of the requesting object, must be unique under its parent. If client does not set this field, the service will generate one.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createQuotaPreference

public final QuotaPreference createQuotaPreference(CreateQuotaPreferenceRequest request)

Creates a new QuotaPreference that declares the desired value for a quota.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   CreateQuotaPreferenceRequest request =
       CreateQuotaPreferenceRequest.newBuilder()
           .setParent(LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .setQuotaPreferenceId("quotaPreferenceId-948332050")
           .setQuotaPreference(QuotaPreference.newBuilder().build())
           .addAllIgnoreSafetyChecks(new ArrayList<QuotaSafetyCheck>())
           .build();
   QuotaPreference response = cloudQuotasClient.createQuotaPreference(request);
 }
 

Parameters:

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

createQuotaPreferenceCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateQuotaPreferenceRequest,QuotaPreference> createQuotaPreferenceCallable()

Creates a new QuotaPreference that declares the desired value for a quota.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   CreateQuotaPreferenceRequest request =
       CreateQuotaPreferenceRequest.newBuilder()
           .setParent(LocationName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString())
           .setQuotaPreferenceId("quotaPreferenceId-948332050")
           .setQuotaPreference(QuotaPreference.newBuilder().build())
           .addAllIgnoreSafetyChecks(new ArrayList<QuotaSafetyCheck>())
           .build();
   ApiFuture<QuotaPreference> future =
       cloudQuotasClient.createQuotaPreferenceCallable().futureCall(request);
   // Do something.
   QuotaPreference response = future.get();
 }
 

updateQuotaPreference

public final QuotaPreference updateQuotaPreference(QuotaPreference quotaPreference,
                                                   com.google.protobuf.FieldMask updateMask)

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   QuotaPreference quotaPreference = QuotaPreference.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   QuotaPreference response =
       cloudQuotasClient.updateQuotaPreference(quotaPreference, updateMask);
 }
 

Parameters:

quotaPreference - Required. The resource being updated

updateMask - Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateQuotaPreference

public final QuotaPreference updateQuotaPreference(UpdateQuotaPreferenceRequest request)

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   UpdateQuotaPreferenceRequest request =
       UpdateQuotaPreferenceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setQuotaPreference(QuotaPreference.newBuilder().build())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .addAllIgnoreSafetyChecks(new ArrayList<QuotaSafetyCheck>())
           .build();
   QuotaPreference response = cloudQuotasClient.updateQuotaPreference(request);
 }
 

Parameters:

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

updateQuotaPreferenceCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateQuotaPreferenceRequest,QuotaPreference> updateQuotaPreferenceCallable()

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

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 (CloudQuotasClient cloudQuotasClient = CloudQuotasClient.create()) {
   UpdateQuotaPreferenceRequest request =
       UpdateQuotaPreferenceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setQuotaPreference(QuotaPreference.newBuilder().build())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .addAllIgnoreSafetyChecks(new ArrayList<QuotaSafetyCheck>())
           .build();
   ApiFuture<QuotaPreference> future =
       cloudQuotasClient.updateQuotaPreferenceCallable().futureCall(request);
   // Do something.
   QuotaPreference response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException