Class ServiceUsageClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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().
| 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateAdminOverride |
Updates an admin override. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteAdminOverride |
Deletes an admin override. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateConsumerOverride |
Updates a consumer override. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteConsumerOverride |
Deletes a consumer override. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GenerateServiceIdentity |
Generates service identity for service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedServiceUsageClient(ServiceUsageSettings settings) Constructs an instance of ServiceUsageClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.final OperationCallable<BatchEnableServicesRequest,com.google.protobuf.Empty, OperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.final voidclose()static final ServiceUsageClientcreate()Constructs an instance of ServiceUsageClient with default settings.static final ServiceUsageClientcreate(ServiceUsageSettings settings) Constructs an instance of ServiceUsageClient, using the given settings.static final ServiceUsageClientcreate(ServiceUsageStub stub) Constructs an instance of ServiceUsageClient, using the given stub for making calls.Creates an admin override.Creates an admin override.Creates an admin override.Creates a consumer override.Creates a consumer override.Creates a consumer override.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes an admin override.Deletes an admin override.final OperationCallable<DeleteAdminOverrideRequest,com.google.protobuf.Empty, OperationMetadata> Deletes an admin override.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a consumer override.Deletes a consumer override.final OperationCallable<DeleteConsumerOverrideRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a consumer override.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> disableServiceAsync(DisableServiceRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.final OperationCallable<DisableServiceRequest,com.google.protobuf.Empty, OperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> enableServiceAsync(EnableServiceRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.final OperationCallable<EnableServiceRequest,com.google.protobuf.Empty, OperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.final OperationFuture<ServiceIdentity,com.google.protobuf.Empty> Generates service identity for service.Generates service identity for service.final OperationCallable<GenerateServiceIdentityRequest,ServiceIdentity, com.google.protobuf.Empty> Generates service identity for service.final ConsumerQuotaLimitRetrieves a summary of quota information for a specific quota limit.Retrieves a summary of quota information for a specific quota limit.final ConsumerQuotaMetricRetrieves a summary of quota information for a specific quota metricRetrieves a summary of quota information for a specific quota metricfinal OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final ServicegetService(GetServiceRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.final ServiceUsageSettingsgetStub()Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits.Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits.final OperationCallable<ImportAdminOverridesRequest,ImportAdminOverridesResponse, ImportAdminOverridesMetadata> Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits.Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits.Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits.final OperationCallable<ImportConsumerOverridesRequest,ImportConsumerOverridesResponse, ImportConsumerOverridesMetadata> Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits.booleanbooleanLists all admin overrides on this limit.Lists all admin overrides on this limit.Lists all admin overrides on this limit.Lists all consumer overrides on this limit.Lists all consumer overrides on this limit.final UnaryCallable<ListConsumerOverridesRequest,ServiceUsageClient.ListConsumerOverridesPagedResponse> Lists all consumer overrides on this limit.Retrieves a summary of all quota information visible to the service consumer, organized by service metric.Retrieves a summary of all quota information visible to the service consumer, organized by service metric.final UnaryCallable<ListConsumerQuotaMetricsRequest,ServiceUsageClient.ListConsumerQuotaMetricsPagedResponse> Retrieves a summary of all quota information visible to the service consumer, organized by service metric.listServices(ListServicesRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.voidshutdown()voidUpdates an admin override.Updates an admin override.Updates an admin override.Updates a consumer override.Updates a consumer override.Updates a consumer override.
-
Constructor Details
-
ServiceUsageClient
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.- Throws:
IOException
-
ServiceUsageClient
-
-
Method Details
-
create
Constructs an instance of ServiceUsageClient with default settings.- Throws:
IOException
-
create
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.- Throws:
IOException
-
create
Constructs an instance of ServiceUsageClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServiceUsageSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getHttpJsonOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
enableServiceAsync
@Deprecated public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> enableServiceAsync(EnableServiceRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.Enables a service so that it can be used with a project.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()) { EnableServiceRequest request = EnableServiceRequest.newBuilder().setName("name3373707").build(); serviceUsageClient.enableServiceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
enableServiceOperationCallable
@Deprecated public final OperationCallable<EnableServiceRequest,com.google.protobuf.Empty, enableServiceOperationCallable()OperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.Enables a service so that it can be used with a project.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()) { EnableServiceRequest request = EnableServiceRequest.newBuilder().setName("name3373707").build(); OperationFuture<Empty, OperationMetadata> future = serviceUsageClient.enableServiceOperationCallable().futureCall(request); // Do something. future.get(); } -
enableServiceCallable
Deprecated.This method is deprecated and will be removed in the next major version update.Enables a service so that it can be used with a project.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()) { EnableServiceRequest request = EnableServiceRequest.newBuilder().setName("name3373707").build(); ApiFuture<Operation> future = serviceUsageClient.enableServiceCallable().futureCall(request); // Do something. future.get(); } -
disableServiceAsync
@Deprecated public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> disableServiceAsync(DisableServiceRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.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`
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()) { DisableServiceRequest request = DisableServiceRequest.newBuilder().setName("name3373707").build(); serviceUsageClient.disableServiceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
disableServiceOperationCallable
@Deprecated public final OperationCallable<DisableServiceRequest,com.google.protobuf.Empty, disableServiceOperationCallable()OperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.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`
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()) { DisableServiceRequest request = DisableServiceRequest.newBuilder().setName("name3373707").build(); OperationFuture<Empty, OperationMetadata> future = serviceUsageClient.disableServiceOperationCallable().futureCall(request); // Do something. future.get(); } -
disableServiceCallable
Deprecated.This method is deprecated and will be removed in the next major version update.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`
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()) { DisableServiceRequest request = DisableServiceRequest.newBuilder().setName("name3373707").build(); ApiFuture<Operation> future = serviceUsageClient.disableServiceCallable().futureCall(request); // Do something. future.get(); } -
getService
Deprecated.This method is deprecated and will be removed in the next major version update.Returns the service configuration and enabled state for a given service.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()) { GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build(); Service response = serviceUsageClient.getService(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getServiceCallable
Deprecated.This method is deprecated and will be removed in the next major version update.Returns the service configuration and enabled state for a given service.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()) { GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build(); ApiFuture<Service> future = serviceUsageClient.getServiceCallable().futureCall(request); // Do something. Service response = future.get(); } -
listServices
@Deprecated public final ServiceUsageClient.ListServicesPagedResponse listServices(ListServicesRequest request) Deprecated.This method is deprecated and will be removed in the next major version update.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.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()) { ListServicesRequest request = ListServicesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (Service element : serviceUsageClient.listServices(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listServicesPagedCallable
@Deprecated public final UnaryCallable<ListServicesRequest,ServiceUsageClient.ListServicesPagedResponse> listServicesPagedCallable()Deprecated.This method is deprecated and will be removed in the next major version update.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.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()) { ListServicesRequest request = ListServicesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<Service> future = serviceUsageClient.listServicesPagedCallable().futureCall(request); // Do something. for (Service element : future.get().iterateAll()) { // doThingsWith(element); } } -
listServicesCallable
@Deprecated public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()Deprecated.This method is deprecated and will be removed in the next major version update.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.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()) { ListServicesRequest request = ListServicesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { ListServicesResponse response = serviceUsageClient.listServicesCallable().call(request); for (Service element : response.getServicesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
batchEnableServicesAsync
@Deprecated public final OperationFuture<com.google.protobuf.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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
batchEnableServicesOperationCallable
@Deprecated public final OperationCallable<BatchEnableServicesRequest,com.google.protobuf.Empty, batchEnableServicesOperationCallable()OperationMetadata> 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(); } -
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(); } -
listConsumerQuotaMetrics
public final ServiceUsageClient.ListConsumerQuotaMetricsPagedResponse listConsumerQuotaMetrics(ListConsumerQuotaMetricsRequest request) 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.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()) { ListConsumerQuotaMetricsRequest request = ListConsumerQuotaMetricsRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setView(QuotaView.forNumber(0)) .build(); for (ConsumerQuotaMetric element : serviceUsageClient.listConsumerQuotaMetrics(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listConsumerQuotaMetricsPagedCallable
public final UnaryCallable<ListConsumerQuotaMetricsRequest,ServiceUsageClient.ListConsumerQuotaMetricsPagedResponse> listConsumerQuotaMetricsPagedCallable()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.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()) { ListConsumerQuotaMetricsRequest request = ListConsumerQuotaMetricsRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setView(QuotaView.forNumber(0)) .build(); ApiFuture<ConsumerQuotaMetric> future = serviceUsageClient.listConsumerQuotaMetricsPagedCallable().futureCall(request); // Do something. for (ConsumerQuotaMetric element : future.get().iterateAll()) { // doThingsWith(element); } } -
listConsumerQuotaMetricsCallable
public final UnaryCallable<ListConsumerQuotaMetricsRequest,ListConsumerQuotaMetricsResponse> listConsumerQuotaMetricsCallable()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.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()) { ListConsumerQuotaMetricsRequest request = ListConsumerQuotaMetricsRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setView(QuotaView.forNumber(0)) .build(); while (true) { ListConsumerQuotaMetricsResponse response = serviceUsageClient.listConsumerQuotaMetricsCallable().call(request); for (ConsumerQuotaMetric element : response.getMetricsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getConsumerQuotaMetric
Retrieves a summary of quota information for a specific quota metricSample 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()) { GetConsumerQuotaMetricRequest request = GetConsumerQuotaMetricRequest.newBuilder() .setName("name3373707") .setView(QuotaView.forNumber(0)) .build(); ConsumerQuotaMetric response = serviceUsageClient.getConsumerQuotaMetric(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getConsumerQuotaMetricCallable
public final UnaryCallable<GetConsumerQuotaMetricRequest,ConsumerQuotaMetric> getConsumerQuotaMetricCallable()Retrieves a summary of quota information for a specific quota metricSample 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()) { GetConsumerQuotaMetricRequest request = GetConsumerQuotaMetricRequest.newBuilder() .setName("name3373707") .setView(QuotaView.forNumber(0)) .build(); ApiFuture<ConsumerQuotaMetric> future = serviceUsageClient.getConsumerQuotaMetricCallable().futureCall(request); // Do something. ConsumerQuotaMetric response = future.get(); } -
getConsumerQuotaLimit
Retrieves a summary of quota information for a specific quota limit.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()) { GetConsumerQuotaLimitRequest request = GetConsumerQuotaLimitRequest.newBuilder() .setName("name3373707") .setView(QuotaView.forNumber(0)) .build(); ConsumerQuotaLimit response = serviceUsageClient.getConsumerQuotaLimit(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getConsumerQuotaLimitCallable
public final UnaryCallable<GetConsumerQuotaLimitRequest,ConsumerQuotaLimit> getConsumerQuotaLimitCallable()Retrieves a summary of quota information for a specific quota limit.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()) { GetConsumerQuotaLimitRequest request = GetConsumerQuotaLimitRequest.newBuilder() .setName("name3373707") .setView(QuotaView.forNumber(0)) .build(); ApiFuture<ConsumerQuotaLimit> future = serviceUsageClient.getConsumerQuotaLimitCallable().futureCall(request); // Do something. ConsumerQuotaLimit response = future.get(); } -
createAdminOverrideAsync
public final OperationFuture<QuotaOverride,OperationMetadata> createAdminOverrideAsync(CreateAdminOverrideRequest request) 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.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()) { CreateAdminOverrideRequest request = CreateAdminOverrideRequest.newBuilder() .setParent("parent-995424086") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); QuotaOverride response = serviceUsageClient.createAdminOverrideAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createAdminOverrideOperationCallable
public final OperationCallable<CreateAdminOverrideRequest,QuotaOverride, createAdminOverrideOperationCallable()OperationMetadata> 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.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()) { CreateAdminOverrideRequest request = CreateAdminOverrideRequest.newBuilder() .setParent("parent-995424086") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<QuotaOverride, OperationMetadata> future = serviceUsageClient.createAdminOverrideOperationCallable().futureCall(request); // Do something. QuotaOverride response = future.get(); } -
createAdminOverrideCallable
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.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()) { CreateAdminOverrideRequest request = CreateAdminOverrideRequest.newBuilder() .setParent("parent-995424086") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.createAdminOverrideCallable().futureCall(request); // Do something. Operation response = future.get(); } -
updateAdminOverrideAsync
public final OperationFuture<QuotaOverride,OperationMetadata> updateAdminOverrideAsync(UpdateAdminOverrideRequest request) Updates an admin override.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()) { UpdateAdminOverrideRequest request = UpdateAdminOverrideRequest.newBuilder() .setName("name3373707") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .setUpdateMask(FieldMask.newBuilder().build()) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); QuotaOverride response = serviceUsageClient.updateAdminOverrideAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateAdminOverrideOperationCallable
public final OperationCallable<UpdateAdminOverrideRequest,QuotaOverride, updateAdminOverrideOperationCallable()OperationMetadata> Updates an admin override.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()) { UpdateAdminOverrideRequest request = UpdateAdminOverrideRequest.newBuilder() .setName("name3373707") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .setUpdateMask(FieldMask.newBuilder().build()) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<QuotaOverride, OperationMetadata> future = serviceUsageClient.updateAdminOverrideOperationCallable().futureCall(request); // Do something. QuotaOverride response = future.get(); } -
updateAdminOverrideCallable
Updates an admin override.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()) { UpdateAdminOverrideRequest request = UpdateAdminOverrideRequest.newBuilder() .setName("name3373707") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .setUpdateMask(FieldMask.newBuilder().build()) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.updateAdminOverrideCallable().futureCall(request); // Do something. Operation response = future.get(); } -
deleteAdminOverrideAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteAdminOverrideAsync(DeleteAdminOverrideRequest request) Deletes an admin override.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()) { DeleteAdminOverrideRequest request = DeleteAdminOverrideRequest.newBuilder() .setName("name3373707") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); serviceUsageClient.deleteAdminOverrideAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteAdminOverrideOperationCallable
public final OperationCallable<DeleteAdminOverrideRequest,com.google.protobuf.Empty, deleteAdminOverrideOperationCallable()OperationMetadata> Deletes an admin override.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()) { DeleteAdminOverrideRequest request = DeleteAdminOverrideRequest.newBuilder() .setName("name3373707") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<Empty, OperationMetadata> future = serviceUsageClient.deleteAdminOverrideOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteAdminOverrideCallable
Deletes an admin override.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()) { DeleteAdminOverrideRequest request = DeleteAdminOverrideRequest.newBuilder() .setName("name3373707") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.deleteAdminOverrideCallable().futureCall(request); // Do something. future.get(); } -
listAdminOverrides
public final ServiceUsageClient.ListAdminOverridesPagedResponse listAdminOverrides(ListAdminOverridesRequest request) Lists all admin overrides on this limit.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()) { ListAdminOverridesRequest request = ListAdminOverridesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (QuotaOverride element : serviceUsageClient.listAdminOverrides(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listAdminOverridesPagedCallable
public final UnaryCallable<ListAdminOverridesRequest,ServiceUsageClient.ListAdminOverridesPagedResponse> listAdminOverridesPagedCallable()Lists all admin overrides on this limit.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()) { ListAdminOverridesRequest request = ListAdminOverridesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<QuotaOverride> future = serviceUsageClient.listAdminOverridesPagedCallable().futureCall(request); // Do something. for (QuotaOverride element : future.get().iterateAll()) { // doThingsWith(element); } } -
listAdminOverridesCallable
public final UnaryCallable<ListAdminOverridesRequest,ListAdminOverridesResponse> listAdminOverridesCallable()Lists all admin overrides on this limit.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()) { ListAdminOverridesRequest request = ListAdminOverridesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListAdminOverridesResponse response = serviceUsageClient.listAdminOverridesCallable().call(request); for (QuotaOverride element : response.getOverridesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
importAdminOverridesAsync
public final OperationFuture<ImportAdminOverridesResponse,ImportAdminOverridesMetadata> importAdminOverridesAsync(ImportAdminOverridesRequest request) 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.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()) { ImportAdminOverridesRequest request = ImportAdminOverridesRequest.newBuilder() .setParent("parent-995424086") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ImportAdminOverridesResponse response = serviceUsageClient.importAdminOverridesAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
importAdminOverridesOperationCallable
public final OperationCallable<ImportAdminOverridesRequest,ImportAdminOverridesResponse, importAdminOverridesOperationCallable()ImportAdminOverridesMetadata> 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.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()) { ImportAdminOverridesRequest request = ImportAdminOverridesRequest.newBuilder() .setParent("parent-995424086") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<ImportAdminOverridesResponse, ImportAdminOverridesMetadata> future = serviceUsageClient.importAdminOverridesOperationCallable().futureCall(request); // Do something. ImportAdminOverridesResponse response = future.get(); } -
importAdminOverridesCallable
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.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()) { ImportAdminOverridesRequest request = ImportAdminOverridesRequest.newBuilder() .setParent("parent-995424086") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.importAdminOverridesCallable().futureCall(request); // Do something. Operation response = future.get(); } -
createConsumerOverrideAsync
public final OperationFuture<QuotaOverride,OperationMetadata> createConsumerOverrideAsync(CreateConsumerOverrideRequest request) 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.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()) { CreateConsumerOverrideRequest request = CreateConsumerOverrideRequest.newBuilder() .setParent("parent-995424086") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); QuotaOverride response = serviceUsageClient.createConsumerOverrideAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createConsumerOverrideOperationCallable
public final OperationCallable<CreateConsumerOverrideRequest,QuotaOverride, createConsumerOverrideOperationCallable()OperationMetadata> 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.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()) { CreateConsumerOverrideRequest request = CreateConsumerOverrideRequest.newBuilder() .setParent("parent-995424086") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<QuotaOverride, OperationMetadata> future = serviceUsageClient.createConsumerOverrideOperationCallable().futureCall(request); // Do something. QuotaOverride response = future.get(); } -
createConsumerOverrideCallable
public final UnaryCallable<CreateConsumerOverrideRequest,Operation> createConsumerOverrideCallable()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.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()) { CreateConsumerOverrideRequest request = CreateConsumerOverrideRequest.newBuilder() .setParent("parent-995424086") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.createConsumerOverrideCallable().futureCall(request); // Do something. Operation response = future.get(); } -
updateConsumerOverrideAsync
public final OperationFuture<QuotaOverride,OperationMetadata> updateConsumerOverrideAsync(UpdateConsumerOverrideRequest request) Updates a consumer override.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()) { UpdateConsumerOverrideRequest request = UpdateConsumerOverrideRequest.newBuilder() .setName("name3373707") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .setUpdateMask(FieldMask.newBuilder().build()) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); QuotaOverride response = serviceUsageClient.updateConsumerOverrideAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateConsumerOverrideOperationCallable
public final OperationCallable<UpdateConsumerOverrideRequest,QuotaOverride, updateConsumerOverrideOperationCallable()OperationMetadata> Updates a consumer override.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()) { UpdateConsumerOverrideRequest request = UpdateConsumerOverrideRequest.newBuilder() .setName("name3373707") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .setUpdateMask(FieldMask.newBuilder().build()) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<QuotaOverride, OperationMetadata> future = serviceUsageClient.updateConsumerOverrideOperationCallable().futureCall(request); // Do something. QuotaOverride response = future.get(); } -
updateConsumerOverrideCallable
public final UnaryCallable<UpdateConsumerOverrideRequest,Operation> updateConsumerOverrideCallable()Updates a consumer override.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()) { UpdateConsumerOverrideRequest request = UpdateConsumerOverrideRequest.newBuilder() .setName("name3373707") .setOverride(QuotaOverride.newBuilder().build()) .setForce(true) .setUpdateMask(FieldMask.newBuilder().build()) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.updateConsumerOverrideCallable().futureCall(request); // Do something. Operation response = future.get(); } -
deleteConsumerOverrideAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteConsumerOverrideAsync(DeleteConsumerOverrideRequest request) Deletes a consumer override.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()) { DeleteConsumerOverrideRequest request = DeleteConsumerOverrideRequest.newBuilder() .setName("name3373707") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); serviceUsageClient.deleteConsumerOverrideAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteConsumerOverrideOperationCallable
public final OperationCallable<DeleteConsumerOverrideRequest,com.google.protobuf.Empty, deleteConsumerOverrideOperationCallable()OperationMetadata> Deletes a consumer override.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()) { DeleteConsumerOverrideRequest request = DeleteConsumerOverrideRequest.newBuilder() .setName("name3373707") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<Empty, OperationMetadata> future = serviceUsageClient.deleteConsumerOverrideOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteConsumerOverrideCallable
public final UnaryCallable<DeleteConsumerOverrideRequest,Operation> deleteConsumerOverrideCallable()Deletes a consumer override.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()) { DeleteConsumerOverrideRequest request = DeleteConsumerOverrideRequest.newBuilder() .setName("name3373707") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.deleteConsumerOverrideCallable().futureCall(request); // Do something. future.get(); } -
listConsumerOverrides
public final ServiceUsageClient.ListConsumerOverridesPagedResponse listConsumerOverrides(ListConsumerOverridesRequest request) Lists all consumer overrides on this limit.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()) { ListConsumerOverridesRequest request = ListConsumerOverridesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (QuotaOverride element : serviceUsageClient.listConsumerOverrides(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listConsumerOverridesPagedCallable
public final UnaryCallable<ListConsumerOverridesRequest,ServiceUsageClient.ListConsumerOverridesPagedResponse> listConsumerOverridesPagedCallable()Lists all consumer overrides on this limit.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()) { ListConsumerOverridesRequest request = ListConsumerOverridesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<QuotaOverride> future = serviceUsageClient.listConsumerOverridesPagedCallable().futureCall(request); // Do something. for (QuotaOverride element : future.get().iterateAll()) { // doThingsWith(element); } } -
listConsumerOverridesCallable
public final UnaryCallable<ListConsumerOverridesRequest,ListConsumerOverridesResponse> listConsumerOverridesCallable()Lists all consumer overrides on this limit.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()) { ListConsumerOverridesRequest request = ListConsumerOverridesRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListConsumerOverridesResponse response = serviceUsageClient.listConsumerOverridesCallable().call(request); for (QuotaOverride element : response.getOverridesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
importConsumerOverridesAsync
public final OperationFuture<ImportConsumerOverridesResponse,ImportConsumerOverridesMetadata> importConsumerOverridesAsync(ImportConsumerOverridesRequest request) 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.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()) { ImportConsumerOverridesRequest request = ImportConsumerOverridesRequest.newBuilder() .setParent("parent-995424086") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ImportConsumerOverridesResponse response = serviceUsageClient.importConsumerOverridesAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
importConsumerOverridesOperationCallable
public final OperationCallable<ImportConsumerOverridesRequest,ImportConsumerOverridesResponse, importConsumerOverridesOperationCallable()ImportConsumerOverridesMetadata> 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.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()) { ImportConsumerOverridesRequest request = ImportConsumerOverridesRequest.newBuilder() .setParent("parent-995424086") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); OperationFuture<ImportConsumerOverridesResponse, ImportConsumerOverridesMetadata> future = serviceUsageClient.importConsumerOverridesOperationCallable().futureCall(request); // Do something. ImportConsumerOverridesResponse response = future.get(); } -
importConsumerOverridesCallable
public final UnaryCallable<ImportConsumerOverridesRequest,Operation> importConsumerOverridesCallable()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.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()) { ImportConsumerOverridesRequest request = ImportConsumerOverridesRequest.newBuilder() .setParent("parent-995424086") .setForce(true) .addAllForceOnly(new ArrayList<QuotaSafetyCheck>()) .build(); ApiFuture<Operation> future = serviceUsageClient.importConsumerOverridesCallable().futureCall(request); // Do something. Operation response = future.get(); } -
generateServiceIdentityAsync
public final OperationFuture<ServiceIdentity,com.google.protobuf.Empty> generateServiceIdentityAsync(GenerateServiceIdentityRequest request) Generates service identity for service.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()) { GenerateServiceIdentityRequest request = GenerateServiceIdentityRequest.newBuilder().setParent("parent-995424086").build(); ServiceIdentity response = serviceUsageClient.generateServiceIdentityAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
generateServiceIdentityOperationCallable
public final OperationCallable<GenerateServiceIdentityRequest,ServiceIdentity, generateServiceIdentityOperationCallable()com.google.protobuf.Empty> Generates service identity for service.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()) { GenerateServiceIdentityRequest request = GenerateServiceIdentityRequest.newBuilder().setParent("parent-995424086").build(); OperationFuture<ServiceIdentity, Empty> future = serviceUsageClient.generateServiceIdentityOperationCallable().futureCall(request); // Do something. ServiceIdentity response = future.get(); } -
generateServiceIdentityCallable
public final UnaryCallable<GenerateServiceIdentityRequest,Operation> generateServiceIdentityCallable()Generates service identity for service.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()) { GenerateServiceIdentityRequest request = GenerateServiceIdentityRequest.newBuilder().setParent("parent-995424086").build(); ApiFuture<Operation> future = serviceUsageClient.generateServiceIdentityCallable().futureCall(request); // Do something. Operation response = future.get(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-