Package com.google.api.serviceusage.v1 (2.15.0)

A client to Service Usage API

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

ServiceUsageClient

Service Description: Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.

See Service Usage API

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

BatchEnableServicesRequest

Request message for the BatchEnableServices method.

Protobuf type google.api.serviceusage.v1.BatchEnableServicesRequest

BatchEnableServicesRequest.Builder

Request message for the BatchEnableServices method.

Protobuf type google.api.serviceusage.v1.BatchEnableServicesRequest

BatchEnableServicesResponse

Response message for the BatchEnableServices method. This response message is assigned to the response field of the returned Operation when that operation is done.

Protobuf type google.api.serviceusage.v1.BatchEnableServicesResponse

BatchEnableServicesResponse.Builder

Response message for the BatchEnableServices method. This response message is assigned to the response field of the returned Operation when that operation is done.

Protobuf type google.api.serviceusage.v1.BatchEnableServicesResponse

BatchEnableServicesResponse.EnableFailure

Provides error messages for the failing services.

Protobuf type google.api.serviceusage.v1.BatchEnableServicesResponse.EnableFailure

BatchEnableServicesResponse.EnableFailure.Builder

Provides error messages for the failing services.

Protobuf type google.api.serviceusage.v1.BatchEnableServicesResponse.EnableFailure

BatchGetServicesRequest

Request message for the BatchGetServices method.

Protobuf type google.api.serviceusage.v1.BatchGetServicesRequest

BatchGetServicesRequest.Builder

Request message for the BatchGetServices method.

Protobuf type google.api.serviceusage.v1.BatchGetServicesRequest

BatchGetServicesResponse

Response message for the BatchGetServices method.

Protobuf type google.api.serviceusage.v1.BatchGetServicesResponse

BatchGetServicesResponse.Builder

Response message for the BatchGetServices method.

Protobuf type google.api.serviceusage.v1.BatchGetServicesResponse

DisableServiceRequest

Request message for the DisableService method.

Protobuf type google.api.serviceusage.v1.DisableServiceRequest

DisableServiceRequest.Builder

Request message for the DisableService method.

Protobuf type google.api.serviceusage.v1.DisableServiceRequest

DisableServiceResponse

Response message for the DisableService method. This response message is assigned to the response field of the returned Operation when that operation is done.

Protobuf type google.api.serviceusage.v1.DisableServiceResponse

DisableServiceResponse.Builder

Response message for the DisableService method. This response message is assigned to the response field of the returned Operation when that operation is done.

Protobuf type google.api.serviceusage.v1.DisableServiceResponse

EnableServiceRequest

Request message for the EnableService method.

Protobuf type google.api.serviceusage.v1.EnableServiceRequest

EnableServiceRequest.Builder

Request message for the EnableService method.

Protobuf type google.api.serviceusage.v1.EnableServiceRequest

EnableServiceResponse

Response message for the EnableService method. This response message is assigned to the response field of the returned Operation when that operation is done.

Protobuf type google.api.serviceusage.v1.EnableServiceResponse

EnableServiceResponse.Builder

Response message for the EnableService method. This response message is assigned to the response field of the returned Operation when that operation is done.

Protobuf type google.api.serviceusage.v1.EnableServiceResponse

GetServiceRequest

Request message for the GetService method.

Protobuf type google.api.serviceusage.v1.GetServiceRequest

GetServiceRequest.Builder

Request message for the GetService method.

Protobuf type google.api.serviceusage.v1.GetServiceRequest

ListServicesRequest

Request message for the ListServices method.

Protobuf type google.api.serviceusage.v1.ListServicesRequest

ListServicesRequest.Builder

Request message for the ListServices method.

Protobuf type google.api.serviceusage.v1.ListServicesRequest

ListServicesResponse

Response message for the ListServices method.

Protobuf type google.api.serviceusage.v1.ListServicesResponse

ListServicesResponse.Builder

Response message for the ListServices method.

Protobuf type google.api.serviceusage.v1.ListServicesResponse

OperationMetadata

The operation metadata returned for the batchend services operation.

Protobuf type google.api.serviceusage.v1.OperationMetadata

OperationMetadata.Builder

The operation metadata returned for the batchend services operation.

Protobuf type google.api.serviceusage.v1.OperationMetadata

ResourcesProto

Service

A service that is available for use by the consumer.

Protobuf type google.api.serviceusage.v1.Service

Service.Builder

A service that is available for use by the consumer.

Protobuf type google.api.serviceusage.v1.Service

ServiceConfig

The configuration of the service.

Protobuf type google.api.serviceusage.v1.ServiceConfig

ServiceConfig.Builder

The configuration of the service.

Protobuf type google.api.serviceusage.v1.ServiceConfig

ServiceUsageClient

Service Description: Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.

See 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.

ServiceUsageClient.ListServicesFixedSizeCollection

ServiceUsageClient.ListServicesPage

ServiceUsageClient.ListServicesPagedResponse

ServiceUsageGrpc

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. See Service Usage API

ServiceUsageGrpc.ServiceUsageBlockingStub

A stub to allow clients to do synchronous rpc calls to service ServiceUsage.

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. See Service Usage API

ServiceUsageGrpc.ServiceUsageFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service ServiceUsage.

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. See Service Usage API

ServiceUsageGrpc.ServiceUsageImplBase

Base class for the server implementation of the service ServiceUsage.

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. See Service Usage API

ServiceUsageGrpc.ServiceUsageStub

A stub to allow clients to do asynchronous rpc calls to service ServiceUsage.

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. See Service Usage API

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

ServiceUsageSettings.Builder

Builder for ServiceUsageSettings.

Interfaces

BatchEnableServicesRequestOrBuilder

BatchEnableServicesResponse.EnableFailureOrBuilder

BatchEnableServicesResponseOrBuilder

BatchGetServicesRequestOrBuilder

BatchGetServicesResponseOrBuilder

DisableServiceRequestOrBuilder

DisableServiceResponseOrBuilder

EnableServiceRequestOrBuilder

EnableServiceResponseOrBuilder

GetServiceRequestOrBuilder

ListServicesRequestOrBuilder

ListServicesResponseOrBuilder

OperationMetadataOrBuilder

ServiceConfigOrBuilder

ServiceOrBuilder

ServiceUsageGrpc.AsyncService

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. See Service Usage API

Enums

DisableServiceRequest.CheckIfServiceHasUsage

Enum to determine if service usage should be checked when disabling a service.

Protobuf enum google.api.serviceusage.v1.DisableServiceRequest.CheckIfServiceHasUsage

State

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

Protobuf enum google.api.serviceusage.v1.State