com.google.api.cloudquotas.v1beta

Class QuotaAdjusterSettingsManagerClient

java.lang.Object

com.google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManagerClient

All Implemented Interfaces:

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

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

Service Description: The Quotas Adjuster Settings API is an infrastructure service for Google Cloud that lets service consumers view and update their quota adjuster settings.

- Update quota adjuster settings. - Get the name of the configurations.

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   QuotaAdjusterSettings quotaAdjusterSettings = QuotaAdjusterSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   QuotaAdjusterSettings response =
       quotaAdjusterSettingsManagerClient.updateQuotaAdjusterSettings(
           quotaAdjusterSettings, updateMask);
 }
 

Note: close() needs to be called on the QuotaAdjusterSettingsManagerClient 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
UpdateQuotaAdjusterSettings	RPC Method for updating QuotaAdjusterSettings based on the request	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateQuotaAdjusterSettings(UpdateQuotaAdjusterSettingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateQuotaAdjusterSettings(QuotaAdjusterSettings quotaAdjusterSettings, 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. updateQuotaAdjusterSettingsCallable()
GetQuotaAdjusterSettings	RPC Method for getting QuotaAdjusterSettings based on the request	Request object method variants only take one parameter, a request object, which must be constructed before the call. getQuotaAdjusterSettings(GetQuotaAdjusterSettingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getQuotaAdjusterSettings(QuotaAdjusterSettingsName name) getQuotaAdjusterSettings(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. getQuotaAdjusterSettingsCallable()

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 QuotaAdjusterSettingsManagerSettings 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
 QuotaAdjusterSettingsManagerSettings quotaAdjusterSettingsManagerSettings =
     QuotaAdjusterSettingsManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create(quotaAdjusterSettingsManagerSettings);
 

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
 QuotaAdjusterSettingsManagerSettings quotaAdjusterSettingsManagerSettings =
     QuotaAdjusterSettingsManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create(quotaAdjusterSettingsManagerSettings);
 

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
 QuotaAdjusterSettingsManagerSettings quotaAdjusterSettingsManagerSettings =
     QuotaAdjusterSettingsManagerSettings.newHttpJsonBuilder().build();
 QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create(quotaAdjusterSettingsManagerSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QuotaAdjusterSettingsManagerClient(QuotaAdjusterSettingsManagerSettings settings) Constructs an instance of QuotaAdjusterSettingsManagerClient, using the given settings.
protected	QuotaAdjusterSettingsManagerClient(QuotaAdjusterSettingsManagerStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static QuotaAdjusterSettingsManagerClient	create() Constructs an instance of QuotaAdjusterSettingsManagerClient with default settings.
static QuotaAdjusterSettingsManagerClient	create(QuotaAdjusterSettingsManagerSettings settings) Constructs an instance of QuotaAdjusterSettingsManagerClient, using the given settings.
static QuotaAdjusterSettingsManagerClient	create(QuotaAdjusterSettingsManagerStub stub) Constructs an instance of QuotaAdjusterSettingsManagerClient, using the given stub for making calls.
QuotaAdjusterSettings	getQuotaAdjusterSettings(GetQuotaAdjusterSettingsRequest request) RPC Method for getting QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { GetQuotaAdjusterSettingsRequest request = GetQuotaAdjusterSettingsRequest.newBuilder() .setName( QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]") .toString()) .build(); QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettings(request); }
QuotaAdjusterSettings	getQuotaAdjusterSettings(QuotaAdjusterSettingsName name) RPC Method for getting QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { QuotaAdjusterSettingsName name = QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]"); QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettings(name); }
QuotaAdjusterSettings	getQuotaAdjusterSettings(String name) RPC Method for getting QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { String name = QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString(); QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettings(name); }
com.google.api.gax.rpc.UnaryCallable<GetQuotaAdjusterSettingsRequest,QuotaAdjusterSettings>	getQuotaAdjusterSettingsCallable() RPC Method for getting QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { GetQuotaAdjusterSettingsRequest request = GetQuotaAdjusterSettingsRequest.newBuilder() .setName( QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]") .toString()) .build(); ApiFuture future = quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettingsCallable().futureCall(request); // Do something.
QuotaAdjusterSettingsManagerSettings	getSettings()
QuotaAdjusterSettingsManagerStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
QuotaAdjusterSettings	updateQuotaAdjusterSettings(QuotaAdjusterSettings quotaAdjusterSettings, com.google.protobuf.FieldMask updateMask) RPC Method for updating QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { QuotaAdjusterSettings quotaAdjusterSettings = QuotaAdjusterSettings.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.updateQuotaAdjusterSettings( quotaAdjusterSettings, updateMask); }
QuotaAdjusterSettings	updateQuotaAdjusterSettings(UpdateQuotaAdjusterSettingsRequest request) RPC Method for updating QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { UpdateQuotaAdjusterSettingsRequest request = UpdateQuotaAdjusterSettingsRequest.newBuilder() .setQuotaAdjusterSettings(QuotaAdjusterSettings.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .setValidateOnly(true) .build(); QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.updateQuotaAdjusterSettings(request); }
com.google.api.gax.rpc.UnaryCallable<UpdateQuotaAdjusterSettingsRequest,QuotaAdjusterSettings>	updateQuotaAdjusterSettingsCallable() RPC Method for updating QuotaAdjusterSettings based on the request 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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.create()) { UpdateQuotaAdjusterSettingsRequest request = UpdateQuotaAdjusterSettingsRequest.newBuilder() .setQuotaAdjusterSettings(QuotaAdjusterSettings.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .setValidateOnly(true) .build(); ApiFuture future = quotaAdjusterSettingsManagerClient .updateQuotaAdjusterSettingsCallable() .futureCall(request); // Do something.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuotaAdjusterSettingsManagerClient

protected QuotaAdjusterSettingsManagerClient(QuotaAdjusterSettingsManagerSettings settings)
                                      throws IOException

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

QuotaAdjusterSettingsManagerClient

protected QuotaAdjusterSettingsManagerClient(QuotaAdjusterSettingsManagerStub stub)

Method Detail

create

public static final QuotaAdjusterSettingsManagerClient create()
                                                       throws IOException

Constructs an instance of QuotaAdjusterSettingsManagerClient with default settings.

Throws:

IOException

create

public static final QuotaAdjusterSettingsManagerClient create(QuotaAdjusterSettingsManagerSettings settings)
                                                       throws IOException

Constructs an instance of QuotaAdjusterSettingsManagerClient, 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 QuotaAdjusterSettingsManagerClient create(QuotaAdjusterSettingsManagerStub stub)

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

getSettings

public final QuotaAdjusterSettingsManagerSettings getSettings()

getStub

public QuotaAdjusterSettingsManagerStub getStub()

updateQuotaAdjusterSettings

public final QuotaAdjusterSettings updateQuotaAdjusterSettings(QuotaAdjusterSettings quotaAdjusterSettings,
                                                               com.google.protobuf.FieldMask updateMask)

RPC Method for updating QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   QuotaAdjusterSettings quotaAdjusterSettings = QuotaAdjusterSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   QuotaAdjusterSettings response =
       quotaAdjusterSettingsManagerClient.updateQuotaAdjusterSettings(
           quotaAdjusterSettings, updateMask);
 }
 

Parameters:

quotaAdjusterSettings - Required. The QuotaAdjusterSettings to update.

updateMask - Optional. The list of fields to update.

Throws:

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

updateQuotaAdjusterSettings

public final QuotaAdjusterSettings updateQuotaAdjusterSettings(UpdateQuotaAdjusterSettingsRequest request)

RPC Method for updating QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   UpdateQuotaAdjusterSettingsRequest request =
       UpdateQuotaAdjusterSettingsRequest.newBuilder()
           .setQuotaAdjusterSettings(QuotaAdjusterSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   QuotaAdjusterSettings response =
       quotaAdjusterSettingsManagerClient.updateQuotaAdjusterSettings(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

updateQuotaAdjusterSettingsCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateQuotaAdjusterSettingsRequest,QuotaAdjusterSettings> updateQuotaAdjusterSettingsCallable()

RPC Method for updating QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   UpdateQuotaAdjusterSettingsRequest request =
       UpdateQuotaAdjusterSettingsRequest.newBuilder()
           .setQuotaAdjusterSettings(QuotaAdjusterSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<QuotaAdjusterSettings> future =
       quotaAdjusterSettingsManagerClient
           .updateQuotaAdjusterSettingsCallable()
           .futureCall(request);
   // Do something.
   QuotaAdjusterSettings response = future.get();
 }
 

getQuotaAdjusterSettings

public final QuotaAdjusterSettings getQuotaAdjusterSettings(QuotaAdjusterSettingsName name)

RPC Method for getting QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   QuotaAdjusterSettingsName name =
       QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   QuotaAdjusterSettings response =
       quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettings(name);
 }
 

Parameters:

name - Required. Name of the `quotaAdjusterSettings` configuration. Only a single setting per project is supported.

Throws:

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

getQuotaAdjusterSettings

public final QuotaAdjusterSettings getQuotaAdjusterSettings(String name)

RPC Method for getting QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   String name =
       QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString();
   QuotaAdjusterSettings response =
       quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettings(name);
 }
 

Parameters:

name - Required. Name of the `quotaAdjusterSettings` configuration. Only a single setting per project is supported.

Throws:

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

getQuotaAdjusterSettings

public final QuotaAdjusterSettings getQuotaAdjusterSettings(GetQuotaAdjusterSettingsRequest request)

RPC Method for getting QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   GetQuotaAdjusterSettingsRequest request =
       GetQuotaAdjusterSettingsRequest.newBuilder()
           .setName(
               QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]")
                   .toString())
           .build();
   QuotaAdjusterSettings response =
       quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettings(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

getQuotaAdjusterSettingsCallable

public final com.google.api.gax.rpc.UnaryCallable<GetQuotaAdjusterSettingsRequest,QuotaAdjusterSettings> getQuotaAdjusterSettingsCallable()

RPC Method for getting QuotaAdjusterSettings based on the request

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 (QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient =
     QuotaAdjusterSettingsManagerClient.create()) {
   GetQuotaAdjusterSettingsRequest request =
       GetQuotaAdjusterSettingsRequest.newBuilder()
           .setName(
               QuotaAdjusterSettingsName.ofProjectLocationName("[PROJECT]", "[LOCATION]")
                   .toString())
           .build();
   ApiFuture<QuotaAdjusterSettings> future =
       quotaAdjusterSettingsManagerClient.getQuotaAdjusterSettingsCallable().futureCall(request);
   // Do something.
   QuotaAdjusterSettings 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