Package com.google.api.serviceusage.v1beta1 (2.13.0)

A client to Service Usage API

The interfaces provided are listed below, along with usage samples.

ServiceUsageClient

Sample for ServiceUsageClient:


 // 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);
 }

Classes

AdminQuotaPolicy

Quota policy created by quota administrator.

Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy

AdminQuotaPolicy.Builder

Quota policy created by quota administrator.

Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy

BatchCreateAdminOverridesResponse

Response message for BatchCreateAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateAdminOverridesResponse

BatchCreateAdminOverridesResponse.Builder

Response message for BatchCreateAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateAdminOverridesResponse

BatchCreateConsumerOverridesResponse

Response message for BatchCreateConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateConsumerOverridesResponse

BatchCreateConsumerOverridesResponse.Builder

Response message for BatchCreateConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateConsumerOverridesResponse

BatchEnableServicesRequest

Request message for the BatchEnableServices method.

Protobuf type google.api.serviceusage.v1beta1.BatchEnableServicesRequest

BatchEnableServicesRequest.Builder

Request message for the BatchEnableServices method.

Protobuf type google.api.serviceusage.v1beta1.BatchEnableServicesRequest

ConsumerQuotaLimit

Consumer quota settings for a quota limit.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaLimit

ConsumerQuotaLimit.Builder

Consumer quota settings for a quota limit.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaLimit

ConsumerQuotaMetric

Consumer quota settings for a quota metric.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaMetric

ConsumerQuotaMetric.Builder

Consumer quota settings for a quota metric.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaMetric

CreateAdminOverrideRequest

Request message for CreateAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateAdminOverrideRequest

CreateAdminOverrideRequest.Builder

Request message for CreateAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateAdminOverrideRequest

CreateAdminQuotaPolicyMetadata

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by CreateAdminQuotaPolicy.

Protobuf type google.api.serviceusage.v1beta1.CreateAdminQuotaPolicyMetadata

CreateAdminQuotaPolicyMetadata.Builder

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by CreateAdminQuotaPolicy.

Protobuf type google.api.serviceusage.v1beta1.CreateAdminQuotaPolicyMetadata

CreateConsumerOverrideRequest

Request message for CreateConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateConsumerOverrideRequest

CreateConsumerOverrideRequest.Builder

Request message for CreateConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateConsumerOverrideRequest

DeleteAdminOverrideRequest

Request message for DeleteAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteAdminOverrideRequest

DeleteAdminOverrideRequest.Builder

Request message for DeleteAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteAdminOverrideRequest

DeleteAdminQuotaPolicyMetadata

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by DeleteAdminQuotaPolicy.

Protobuf type google.api.serviceusage.v1beta1.DeleteAdminQuotaPolicyMetadata

DeleteAdminQuotaPolicyMetadata.Builder

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by DeleteAdminQuotaPolicy.

Protobuf type google.api.serviceusage.v1beta1.DeleteAdminQuotaPolicyMetadata

DeleteConsumerOverrideRequest

Request message for DeleteConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteConsumerOverrideRequest

DeleteConsumerOverrideRequest.Builder

Request message for DeleteConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteConsumerOverrideRequest

DisableServiceRequest

Request message for the DisableService method.

Protobuf type google.api.serviceusage.v1beta1.DisableServiceRequest

DisableServiceRequest.Builder

Request message for the DisableService method.

Protobuf type google.api.serviceusage.v1beta1.DisableServiceRequest

EnableServiceRequest

Request message for the EnableService method.

Protobuf type google.api.serviceusage.v1beta1.EnableServiceRequest

EnableServiceRequest.Builder

Request message for the EnableService method.

Protobuf type google.api.serviceusage.v1beta1.EnableServiceRequest

GenerateServiceIdentityRequest

Request message for generating service identity.

Protobuf type google.api.serviceusage.v1beta1.GenerateServiceIdentityRequest

GenerateServiceIdentityRequest.Builder

Request message for generating service identity.

Protobuf type google.api.serviceusage.v1beta1.GenerateServiceIdentityRequest

GetConsumerQuotaLimitRequest

Request message for GetConsumerQuotaLimit

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaLimitRequest

GetConsumerQuotaLimitRequest.Builder

Request message for GetConsumerQuotaLimit

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaLimitRequest

GetConsumerQuotaMetricRequest

Request message for GetConsumerQuotaMetric

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaMetricRequest

GetConsumerQuotaMetricRequest.Builder

Request message for GetConsumerQuotaMetric

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaMetricRequest

GetServiceIdentityMetadata

Metadata for the GetServiceIdentity method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityMetadata

GetServiceIdentityMetadata.Builder

Metadata for the GetServiceIdentity method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityMetadata

GetServiceIdentityResponse

Response message for getting service identity.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityResponse

GetServiceIdentityResponse.Builder

Response message for getting service identity.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityResponse

GetServiceRequest

Request message for the GetService method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceRequest

GetServiceRequest.Builder

Request message for the GetService method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceRequest

ImportAdminOverridesMetadata

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides.

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesMetadata

ImportAdminOverridesMetadata.Builder

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides.

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesMetadata

ImportAdminOverridesRequest

Request message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesRequest

ImportAdminOverridesRequest.Builder

Request message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesRequest

ImportAdminOverridesResponse

Response message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesResponse

ImportAdminOverridesResponse.Builder

Response message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesResponse

ImportAdminQuotaPoliciesMetadata

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminQuotaPolicies.

Protobuf type google.api.serviceusage.v1beta1.ImportAdminQuotaPoliciesMetadata

ImportAdminQuotaPoliciesMetadata.Builder

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminQuotaPolicies.

Protobuf type google.api.serviceusage.v1beta1.ImportAdminQuotaPoliciesMetadata

ImportAdminQuotaPoliciesResponse

Response message for ImportAdminQuotaPolicies

Protobuf type google.api.serviceusage.v1beta1.ImportAdminQuotaPoliciesResponse

ImportAdminQuotaPoliciesResponse.Builder

Response message for ImportAdminQuotaPolicies

Protobuf type google.api.serviceusage.v1beta1.ImportAdminQuotaPoliciesResponse

ImportConsumerOverridesMetadata

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportConsumerOverrides.

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesMetadata

ImportConsumerOverridesMetadata.Builder

Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportConsumerOverrides.

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesMetadata

ImportConsumerOverridesRequest

Request message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesRequest

ImportConsumerOverridesRequest.Builder

Request message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesRequest

ImportConsumerOverridesResponse

Response message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesResponse

ImportConsumerOverridesResponse.Builder

Response message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesResponse

ListAdminOverridesRequest

Request message for ListAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesRequest

ListAdminOverridesRequest.Builder

Request message for ListAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesRequest

ListAdminOverridesResponse

Response message for ListAdminOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesResponse

ListAdminOverridesResponse.Builder

Response message for ListAdminOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesResponse

ListConsumerOverridesRequest

Request message for ListConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesRequest

ListConsumerOverridesRequest.Builder

Request message for ListConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesRequest

ListConsumerOverridesResponse

Response message for ListConsumerOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesResponse

ListConsumerOverridesResponse.Builder

Response message for ListConsumerOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesResponse

ListConsumerQuotaMetricsRequest

Request message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsRequest

ListConsumerQuotaMetricsRequest.Builder

Request message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsRequest

ListConsumerQuotaMetricsResponse

Response message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsResponse

ListConsumerQuotaMetricsResponse.Builder

Response message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsResponse

ListServicesRequest

Request message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesRequest

ListServicesRequest.Builder

Request message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesRequest

ListServicesResponse

Response message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesResponse

ListServicesResponse.Builder

Response message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesResponse

OperationMetadata

The operation metadata returned for the batchend services operation.

Protobuf type google.api.serviceusage.v1beta1.OperationMetadata

OperationMetadata.Builder

The operation metadata returned for the batchend services operation.

Protobuf type google.api.serviceusage.v1beta1.OperationMetadata

OverrideInlineSource

Import data embedded in the request message

Protobuf type google.api.serviceusage.v1beta1.OverrideInlineSource

OverrideInlineSource.Builder

Import data embedded in the request message

Protobuf type google.api.serviceusage.v1beta1.OverrideInlineSource

QuotaBucket

A quota bucket is a quota provisioning unit for a specific set of dimensions.

Protobuf type google.api.serviceusage.v1beta1.QuotaBucket

QuotaBucket.Builder

A quota bucket is a quota provisioning unit for a specific set of dimensions.

Protobuf type google.api.serviceusage.v1beta1.QuotaBucket

QuotaOverride

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

QuotaOverride.Builder

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

Service

A service that is available for use by the consumer.

Protobuf type google.api.serviceusage.v1beta1.Service

Service.Builder

A service that is available for use by the consumer.

Protobuf type google.api.serviceusage.v1beta1.Service

ServiceConfig

The configuration of the service.

Protobuf type google.api.serviceusage.v1beta1.ServiceConfig

ServiceConfig.Builder

The configuration of the service.

Protobuf type google.api.serviceusage.v1beta1.ServiceConfig

ServiceIdentity

Service identity for a service. This is the identity that service producer should use to access consumer resources.

Protobuf type google.api.serviceusage.v1beta1.ServiceIdentity

ServiceIdentity.Builder

Service identity for a service. This is the identity that service producer should use to access consumer resources.

Protobuf type google.api.serviceusage.v1beta1.ServiceIdentity

ServiceUsageClient

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns 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.

ServiceUsageClient.ListAdminOverridesFixedSizeCollection

ServiceUsageClient.ListAdminOverridesPage

ServiceUsageClient.ListAdminOverridesPagedResponse

ServiceUsageClient.ListConsumerOverridesFixedSizeCollection

ServiceUsageClient.ListConsumerOverridesPage

ServiceUsageClient.ListConsumerOverridesPagedResponse

ServiceUsageClient.ListConsumerQuotaMetricsFixedSizeCollection

ServiceUsageClient.ListConsumerQuotaMetricsPage

ServiceUsageClient.ListConsumerQuotaMetricsPagedResponse

ServiceUsageClient.ListServicesFixedSizeCollection

ServiceUsageClient.ListServicesPage

ServiceUsageClient.ListServicesPagedResponse

ServiceUsageProto

ServiceUsageSettings

Settings class to configure an instance of ServiceUsageClient.

The default instance has everything set to sensible defaults:

The default service address (serviceusage.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getService to 30 seconds:


 // 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.Builder serviceUsageSettingsBuilder = ServiceUsageSettings.newBuilder();
 serviceUsageSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         serviceUsageSettingsBuilder
             .getServiceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ServiceUsageSettings serviceUsageSettings = serviceUsageSettingsBuilder.build();

Package com.google.api.serviceusage.v1beta1 (2.13.0)

ServiceUsageClient

Classes

Interfaces