Class QuotaServiceClient (0.5.0)

GitHub RepositoryProduct Reference

Service Description: Service to get method call quota information per Merchant API method.

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 (QuotaServiceClient quotaServiceClient = QuotaServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (QuotaGroup element : quotaServiceClient.listQuotaGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the QuotaServiceClient 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

ListQuotaGroups

Lists the daily call quota and usage per group for your Merchant Center account.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listQuotaGroups(ListQuotaGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listQuotaGroups(AccountName parent)

  • listQuotaGroups(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.

  • listQuotaGroupsPagedCallable()

  • listQuotaGroupsCallable()

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 QuotaServiceSettings 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
 QuotaServiceSettings quotaServiceSettings =
     QuotaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 QuotaServiceClient quotaServiceClient = QuotaServiceClient.create(quotaServiceSettings);

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
 QuotaServiceSettings quotaServiceSettings =
     QuotaServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 QuotaServiceClient quotaServiceClient = QuotaServiceClient.create(quotaServiceSettings);

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
 QuotaServiceSettings quotaServiceSettings = QuotaServiceSettings.newHttpJsonBuilder().build();
 QuotaServiceClient quotaServiceClient = QuotaServiceClient.create(quotaServiceSettings);

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

Inheritance

java.lang.Object > QuotaServiceClient

Static Methods

create()

public static final QuotaServiceClient create()

Constructs an instance of QuotaServiceClient with default settings.

Returns
Type Description
QuotaServiceClient
Exceptions
Type Description
IOException

create(QuotaServiceSettings settings)

public static final QuotaServiceClient create(QuotaServiceSettings settings)

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

Parameter
Name Description
settings QuotaServiceSettings
Returns
Type Description
QuotaServiceClient
Exceptions
Type Description
IOException

create(QuotaServiceStub stub)

public static final QuotaServiceClient create(QuotaServiceStub stub)

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

Parameter
Name Description
stub QuotaServiceStub
Returns
Type Description
QuotaServiceClient

Constructors

QuotaServiceClient(QuotaServiceSettings settings)

protected QuotaServiceClient(QuotaServiceSettings settings)

Constructs an instance of QuotaServiceClient, 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
Name Description
settings QuotaServiceSettings

QuotaServiceClient(QuotaServiceStub stub)

protected QuotaServiceClient(QuotaServiceStub stub)
Parameter
Name Description
stub QuotaServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getSettings()

public final QuotaServiceSettings getSettings()
Returns
Type Description
QuotaServiceSettings

getStub()

public QuotaServiceStub getStub()
Returns
Type Description
QuotaServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listQuotaGroups(AccountName parent)

public final QuotaServiceClient.ListQuotaGroupsPagedResponse listQuotaGroups(AccountName parent)

Lists the daily call quota and usage per group for your Merchant Center account.

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 (QuotaServiceClient quotaServiceClient = QuotaServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (QuotaGroup element : quotaServiceClient.listQuotaGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AccountName

Required. The merchant account who owns the collection of method quotas Format: accounts/{account}
Returns
Type Description
QuotaServiceClient.ListQuotaGroupsPagedResponse

listQuotaGroups(ListQuotaGroupsRequest request)

public final QuotaServiceClient.ListQuotaGroupsPagedResponse listQuotaGroups(ListQuotaGroupsRequest request)

Lists the daily call quota and usage per group for your Merchant Center account.

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 (QuotaServiceClient quotaServiceClient = QuotaServiceClient.create()) {
   ListQuotaGroupsRequest request =
       ListQuotaGroupsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (QuotaGroup element : quotaServiceClient.listQuotaGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListQuotaGroupsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
QuotaServiceClient.ListQuotaGroupsPagedResponse

listQuotaGroups(String parent)

public final QuotaServiceClient.ListQuotaGroupsPagedResponse listQuotaGroups(String parent)

Lists the daily call quota and usage per group for your Merchant Center account.

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 (QuotaServiceClient quotaServiceClient = QuotaServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (QuotaGroup element : quotaServiceClient.listQuotaGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The merchant account who owns the collection of method quotas Format: accounts/{account}
Returns
Type Description
QuotaServiceClient.ListQuotaGroupsPagedResponse

listQuotaGroupsCallable()

public final UnaryCallable<ListQuotaGroupsRequest,ListQuotaGroupsResponse> listQuotaGroupsCallable()

Lists the daily call quota and usage per group for your Merchant Center account.

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 (QuotaServiceClient quotaServiceClient = QuotaServiceClient.create()) {
   ListQuotaGroupsRequest request =
       ListQuotaGroupsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListQuotaGroupsResponse response =
         quotaServiceClient.listQuotaGroupsCallable().call(request);
     for (QuotaGroup element : response.getQuotaGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListQuotaGroupsRequest,ListQuotaGroupsResponse>

listQuotaGroupsPagedCallable()

public final UnaryCallable<ListQuotaGroupsRequest,QuotaServiceClient.ListQuotaGroupsPagedResponse> listQuotaGroupsPagedCallable()

Lists the daily call quota and usage per group for your Merchant Center account.

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 (QuotaServiceClient quotaServiceClient = QuotaServiceClient.create()) {
   ListQuotaGroupsRequest request =
       ListQuotaGroupsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<QuotaGroup> future =
       quotaServiceClient.listQuotaGroupsPagedCallable().futureCall(request);
   // Do something.
   for (QuotaGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListQuotaGroupsRequest,ListQuotaGroupsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()