Class ServiceUsageClient (2.99.0)

GitHub RepositoryProduct Reference

Service Description: Service Usage API

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 (ServiceUsageClient serviceUsageClient = ServiceUsageClient.create()) {
   GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build();
   Service response = serviceUsageClient.getService(request);
 }

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

EnableService

Enables a service so that it can be used with a project.

Operation response type: google.protobuf.Empty

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

  • enableServiceAsync(EnableServiceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • enableServiceOperationCallable()

  • enableServiceCallable()

DisableService

Disables a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks.

It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a FAILED_PRECONDITION status if the target service is not currently enabled.

Operation response type: google.protobuf.Empty

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

  • disableServiceAsync(DisableServiceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • disableServiceOperationCallable()

  • disableServiceCallable()

GetService

Returns the service configuration and enabled state for a given service.

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

  • getService(GetServiceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getServiceCallable()

ListServices

Lists all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the servicemanagement.services.bind permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.

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

  • listServices(ListServicesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listServicesPagedCallable()

  • listServicesCallable()

BatchEnableServices

Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur.

Operation response type: google.protobuf.Empty

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

  • batchEnableServicesAsync(BatchEnableServicesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchEnableServicesOperationCallable()

  • batchEnableServicesCallable()

ListConsumerQuotaMetrics

Retrieves a summary of all quota information visible to the service consumer, organized by service metric. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.

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

  • listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConsumerQuotaMetricsPagedCallable()

  • listConsumerQuotaMetricsCallable()

GetConsumerQuotaMetric

Retrieves a summary of quota information for a specific quota metric

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

  • getConsumerQuotaMetric(GetConsumerQuotaMetricRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getConsumerQuotaMetricCallable()

GetConsumerQuotaLimit

Retrieves a summary of quota information for a specific quota limit.

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

  • getConsumerQuotaLimit(GetConsumerQuotaLimitRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getConsumerQuotaLimitCallable()

CreateAdminOverride

Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.

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

  • createAdminOverrideAsync(CreateAdminOverrideRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAdminOverrideOperationCallable()

  • createAdminOverrideCallable()

UpdateAdminOverride

Updates an admin override.

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

  • updateAdminOverrideAsync(UpdateAdminOverrideRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAdminOverrideOperationCallable()

  • updateAdminOverrideCallable()

DeleteAdminOverride

Deletes an admin override.

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

  • deleteAdminOverrideAsync(DeleteAdminOverrideRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAdminOverrideOperationCallable()

  • deleteAdminOverrideCallable()

ListAdminOverrides

Lists all admin overrides on this limit.

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

  • listAdminOverrides(ListAdminOverridesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAdminOverridesPagedCallable()

  • listAdminOverridesCallable()

ImportAdminOverrides

Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

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

  • importAdminOverridesAsync(ImportAdminOverridesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • importAdminOverridesOperationCallable()

  • importAdminOverridesCallable()

CreateConsumerOverride

Creates a consumer override. A consumer override is applied to the consumer on its own authority to limit its own quota usage. Consumer overrides cannot be used to grant more quota than would be allowed by admin overrides, producer overrides, or the default limit of the service.

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

  • createConsumerOverrideAsync(CreateConsumerOverrideRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createConsumerOverrideOperationCallable()

  • createConsumerOverrideCallable()

UpdateConsumerOverride

Updates a consumer override.

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

  • updateConsumerOverrideAsync(UpdateConsumerOverrideRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateConsumerOverrideOperationCallable()

  • updateConsumerOverrideCallable()

DeleteConsumerOverride

Deletes a consumer override.

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

  • deleteConsumerOverrideAsync(DeleteConsumerOverrideRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteConsumerOverrideOperationCallable()

  • deleteConsumerOverrideCallable()

ListConsumerOverrides

Lists all consumer overrides on this limit.

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

  • listConsumerOverrides(ListConsumerOverridesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConsumerOverridesPagedCallable()

  • listConsumerOverridesCallable()

ImportConsumerOverrides

Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

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

  • importConsumerOverridesAsync(ImportConsumerOverridesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • importConsumerOverridesOperationCallable()

  • importConsumerOverridesCallable()

GenerateServiceIdentity

Generates service identity for service.

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

  • generateServiceIdentityAsync(GenerateServiceIdentityRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • generateServiceIdentityOperationCallable()

  • generateServiceIdentityCallable()

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 ServiceUsageSettings 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
 ServiceUsageSettings serviceUsageSettings =
     ServiceUsageSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServiceUsageClient serviceUsageClient = ServiceUsageClient.create(serviceUsageSettings);

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
 ServiceUsageSettings serviceUsageSettings =
     ServiceUsageSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServiceUsageClient serviceUsageClient = ServiceUsageClient.create(serviceUsageSettings);

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
 ServiceUsageSettings serviceUsageSettings = ServiceUsageSettings.newHttpJsonBuilder().build();
 ServiceUsageClient serviceUsageClient = ServiceUsageClient.create(serviceUsageSettings);

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

Inheritance

java.lang.Object > ServiceUsageClient

Static Methods

create()

public static final ServiceUsageClient create()

Constructs an instance of ServiceUsageClient with default settings.

Returns
Type Description
ServiceUsageClient
Exceptions
Type Description
IOException

create(ServiceUsageSettings settings)

public static final ServiceUsageClient create(ServiceUsageSettings settings)

Constructs an instance of ServiceUsageClient, 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 ServiceUsageSettings
Returns
Type Description
ServiceUsageClient
Exceptions
Type Description
IOException

create(ServiceUsageStub stub)

public static final ServiceUsageClient create(ServiceUsageStub stub)

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

Parameter
Name Description
stub ServiceUsageStub
Returns
Type Description
ServiceUsageClient

Constructors

ServiceUsageClient(ServiceUsageSettings settings)

protected ServiceUsageClient(ServiceUsageSettings settings)

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

ServiceUsageClient(ServiceUsageStub stub)

protected ServiceUsageClient(ServiceUsageStub stub)
Parameter
Name Description
stub ServiceUsageStub

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

batchEnableServicesAsync(BatchEnableServicesRequest request) (deprecated)

public final OperationFuture<Empty,OperationMetadata> batchEnableServicesAsync(BatchEnableServicesRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur.

Operation response type: google.protobuf.Empty

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 (ServiceUsageClient serviceUsageClient = ServiceUsageClient.create()) {
   BatchEnableServicesRequest request =
       BatchEnableServicesRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllServiceIds(new ArrayList<String>())
           .build();
   serviceUsageClient.batchEnableServicesAsync(request).get();
 }
Parameter
Name Description
request BatchEnableServicesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

batchEnableServicesCallable() (deprecated)

public final UnaryCallable<BatchEnableServicesRequest,Operation> batchEnableServicesCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur.

Operation response type: google.protobuf.Empty

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 (ServiceUsageClient serviceUsageClient = ServiceUsageClient.create()) {
   BatchEnableServicesRequest request =
       BatchEnableServicesRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllServiceIds(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future =
       serviceUsageClient.batchEnableServicesCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<BatchEnableServicesRequest,Operation>

batchEnableServicesOperationCallable() (deprecated)

public final OperationCallable<BatchEnableServicesRequest,Empty,OperationMetadata> batchEnableServicesOperationCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur.

Operation response type: google.protobuf.Empty

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 (ServiceUsageClient serviceUsageClient = ServiceUsageClient.create()) {
   BatchEnableServicesRequest request =
       BatchEnableServicesRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllServiceIds(new ArrayList<String>())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       serviceUsageClient.batchEnableServicesOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<BatchEnableServicesRequest,Empty,OperationMetadata>

close()

public final void close()

createAdminOverrideAsync(CreateAdminOverrideRequest request)

public