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

Quota policy created by quota administrator.

Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy

Quota policy created by quota administrator.

Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy

Response message for BatchCreateAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateAdminOverridesResponse

Response message for BatchCreateAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateAdminOverridesResponse

Response message for BatchCreateConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateConsumerOverridesResponse

Response message for BatchCreateConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.BatchCreateConsumerOverridesResponse

Request message for the BatchEnableServices method.

Protobuf type google.api.serviceusage.v1beta1.BatchEnableServicesRequest

Request message for the BatchEnableServices method.

Protobuf type google.api.serviceusage.v1beta1.BatchEnableServicesRequest

Consumer quota settings for a quota limit.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaLimit

Consumer quota settings for a quota limit.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaLimit

Consumer quota settings for a quota metric.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaMetric

Consumer quota settings for a quota metric.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaMetric

Request message for CreateAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateAdminOverrideRequest

Request message for CreateAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateAdminOverrideRequest

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

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

Request message for CreateConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateConsumerOverrideRequest

Request message for CreateConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.CreateConsumerOverrideRequest

Request message for DeleteAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteAdminOverrideRequest

Request message for DeleteAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteAdminOverrideRequest

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

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

Request message for DeleteConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteConsumerOverrideRequest

Request message for DeleteConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.DeleteConsumerOverrideRequest

Request message for the DisableService method.

Protobuf type google.api.serviceusage.v1beta1.DisableServiceRequest

Request message for the DisableService method.

Protobuf type google.api.serviceusage.v1beta1.DisableServiceRequest

Request message for the EnableService method.

Protobuf type google.api.serviceusage.v1beta1.EnableServiceRequest

Request message for the EnableService method.

Protobuf type google.api.serviceusage.v1beta1.EnableServiceRequest

Request message for generating service identity.

Protobuf type google.api.serviceusage.v1beta1.GenerateServiceIdentityRequest

Request message for generating service identity.

Protobuf type google.api.serviceusage.v1beta1.GenerateServiceIdentityRequest

Request message for GetConsumerQuotaLimit

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaLimitRequest

Request message for GetConsumerQuotaLimit

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaLimitRequest

Request message for GetConsumerQuotaMetric

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaMetricRequest

Request message for GetConsumerQuotaMetric

Protobuf type google.api.serviceusage.v1beta1.GetConsumerQuotaMetricRequest

Metadata for the GetServiceIdentity method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityMetadata

Metadata for the GetServiceIdentity method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityMetadata

Response message for getting service identity.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityResponse

Response message for getting service identity.

Protobuf type google.api.serviceusage.v1beta1.GetServiceIdentityResponse

Request message for the GetService method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceRequest

Request message for the GetService method.

Protobuf type google.api.serviceusage.v1beta1.GetServiceRequest

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

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

Request message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesRequest

Request message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesRequest

Response message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesResponse

Response message for ImportAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportAdminOverridesResponse

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

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

Response message for ImportAdminQuotaPolicies

Protobuf type google.api.serviceusage.v1beta1.ImportAdminQuotaPoliciesResponse

Response message for ImportAdminQuotaPolicies

Protobuf type google.api.serviceusage.v1beta1.ImportAdminQuotaPoliciesResponse

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

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

Request message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesRequest

Request message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesRequest

Response message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesResponse

Response message for ImportConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ImportConsumerOverridesResponse

Request message for ListAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesRequest

Request message for ListAdminOverrides

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesRequest

Response message for ListAdminOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesResponse

Response message for ListAdminOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListAdminOverridesResponse

Request message for ListConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesRequest

Request message for ListConsumerOverrides

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesRequest

Response message for ListConsumerOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesResponse

Response message for ListConsumerOverrides.

Protobuf type google.api.serviceusage.v1beta1.ListConsumerOverridesResponse

Request message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsRequest

Request message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsRequest

Response message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsResponse

Response message for ListConsumerQuotaMetrics

Protobuf type google.api.serviceusage.v1beta1.ListConsumerQuotaMetricsResponse

Request message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesRequest

Request message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesRequest

Response message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesResponse

Response message for the ListServices method.

Protobuf type google.api.serviceusage.v1beta1.ListServicesResponse

The operation metadata returned for the batchend services operation.

Protobuf type google.api.serviceusage.v1beta1.OperationMetadata

The operation metadata returned for the batchend services operation.

Protobuf type google.api.serviceusage.v1beta1.OperationMetadata

Import data embedded in the request message

Protobuf type google.api.serviceusage.v1beta1.OverrideInlineSource

Import data embedded in the request message

Protobuf type google.api.serviceusage.v1beta1.OverrideInlineSource

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

Protobuf type google.api.serviceusage.v1beta1.QuotaBucket

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

Protobuf type google.api.serviceusage.v1beta1.QuotaBucket

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

A service that is available for use by the consumer.

Protobuf type google.api.serviceusage.v1beta1.Service

A service that is available for use by the consumer.

Protobuf type google.api.serviceusage.v1beta1.Service

The configuration of the service.

Protobuf type google.api.serviceusage.v1beta1.ServiceConfig

The configuration of the service.

Protobuf type google.api.serviceusage.v1beta1.ServiceConfig

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

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

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:

1. 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.
2. 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.
3. 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.

Service Usage API

Service Usage API

Service Usage API

Service Usage API

Service Usage API

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

Builder for ServiceUsageSettings.

Request message for UpdateAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.UpdateAdminOverrideRequest

Request message for UpdateAdminOverride.

Protobuf type google.api.serviceusage.v1beta1.UpdateAdminOverrideRequest

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

Protobuf type google.api.serviceusage.v1beta1.UpdateAdminQuotaPolicyMetadata

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

Protobuf type google.api.serviceusage.v1beta1.UpdateAdminQuotaPolicyMetadata

Request message for UpdateConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.UpdateConsumerOverrideRequest

Request message for UpdateConsumerOverride.

Protobuf type google.api.serviceusage.v1beta1.UpdateConsumerOverrideRequest

Enum for service identity state.

Protobuf enum google.api.serviceusage.v1beta1.GetServiceIdentityResponse.IdentityState

Enumerations of quota safety checks.

Protobuf enum google.api.serviceusage.v1beta1.QuotaSafetyCheck

Selected view of quota. Can be used to request more detailed quota information when retrieving quota metrics and limits.

Protobuf enum google.api.serviceusage.v1beta1.QuotaView

Whether or not a service has been enabled for use by a consumer.

Protobuf enum google.api.serviceusage.v1beta1.State