Package com.google.cloud.billing.v1 (2.24.0)

A client to Cloud Billing API

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

CloudBillingClient

Service Description: Retrieves the Google Cloud Console billing accounts and associates them with projects.

Sample for CloudBillingClient:


 // 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 (CloudBillingClient cloudBillingClient = CloudBillingClient.create()) {
   BillingAccountName name = BillingAccountName.of("[BILLING_ACCOUNT]");
   BillingAccount response = cloudBillingClient.getBillingAccount(name);
 }

CloudCatalogClient

Service Description: A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.

Sample for CloudCatalogClient:


 // 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 (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   for (Service element : cloudCatalogClient.listServices().iterateAll()) {
     // doThingsWith(element);
   }
 }

Classes

AggregationInfo

Represents the aggregation level and interval for pricing of a single SKU.

Protobuf type google.cloud.billing.v1.AggregationInfo

AggregationInfo.Builder

Represents the aggregation level and interval for pricing of a single SKU.

Protobuf type google.cloud.billing.v1.AggregationInfo

BillingAccount

A billing account in the Google Cloud Console. You can assign a billing account to one or more projects.

Protobuf type google.cloud.billing.v1.BillingAccount

BillingAccount.Builder

A billing account in the Google Cloud Console. You can assign a billing account to one or more projects.

Protobuf type google.cloud.billing.v1.BillingAccount

BillingAccountName.Builder

Builder for billingAccounts/{billing_account}.

Category.Builder

Represents the category hierarchy of a SKU.

Protobuf type google.cloud.billing.v1.Category

CloudBillingClient

Service Description: Retrieves the Google Cloud Console billing accounts and associates them with projects.

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 (CloudBillingClient cloudBillingClient = CloudBillingClient.create()) {
   BillingAccountName name = BillingAccountName.of("[BILLING_ACCOUNT]");
   BillingAccount response = cloudBillingClient.getBillingAccount(name);
 }

Note: close() needs to be called on the CloudBillingClient 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 CloudBillingSettings 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
 CloudBillingSettings cloudBillingSettings =
     CloudBillingSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudBillingClient cloudBillingClient = CloudBillingClient.create(cloudBillingSettings);

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
 CloudBillingSettings cloudBillingSettings =
     CloudBillingSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudBillingClient cloudBillingClient = CloudBillingClient.create(cloudBillingSettings);

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
 CloudBillingSettings cloudBillingSettings = CloudBillingSettings.newHttpJsonBuilder().build();
 CloudBillingClient cloudBillingClient = CloudBillingClient.create(cloudBillingSettings);

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

CloudBillingClient.ListBillingAccountsFixedSizeCollection

CloudBillingClient.ListBillingAccountsPage

CloudBillingClient.ListBillingAccountsPagedResponse

CloudBillingClient.ListProjectBillingInfoFixedSizeCollection

CloudBillingClient.ListProjectBillingInfoPage

CloudBillingClient.ListProjectBillingInfoPagedResponse

CloudBillingGrpc

Retrieves the Google Cloud Console billing accounts and associates them with projects.

CloudBillingGrpc.CloudBillingBlockingStub

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

Retrieves the Google Cloud Console billing accounts and associates them with projects.

CloudBillingGrpc.CloudBillingFutureStub

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

Retrieves the Google Cloud Console billing accounts and associates them with projects.

CloudBillingGrpc.CloudBillingImplBase

Base class for the server implementation of the service CloudBilling.

Retrieves the Google Cloud Console billing accounts and associates them with projects.

CloudBillingGrpc.CloudBillingStub

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

Retrieves the Google Cloud Console billing accounts and associates them with projects.

CloudBillingProto

CloudBillingSettings

Settings class to configure an instance of CloudBillingClient.

The default instance has everything set to sensible defaults:

The default service address (cloudbilling.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 getBillingAccount 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
 CloudBillingSettings.Builder cloudBillingSettingsBuilder = CloudBillingSettings.newBuilder();
 cloudBillingSettingsBuilder
     .getBillingAccountSettings()
     .setRetrySettings(
         cloudBillingSettingsBuilder
             .getBillingAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudBillingSettings cloudBillingSettings = cloudBillingSettingsBuilder.build();

CloudBillingSettings.Builder

Builder for CloudBillingSettings.

CloudCatalogClient

Service Description: A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.

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 (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   for (Service element : cloudCatalogClient.listServices().iterateAll()) {
     // doThingsWith(element);
   }
 }

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

This class can be customized by passing in a custom instance of CloudCatalogSettings 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
 CloudCatalogSettings cloudCatalogSettings =
     CloudCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create(cloudCatalogSettings);

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
 CloudCatalogSettings cloudCatalogSettings =
     CloudCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create(cloudCatalogSettings);

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
 CloudCatalogSettings cloudCatalogSettings = CloudCatalogSettings.newHttpJsonBuilder().build();
 CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create(cloudCatalogSettings);

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

CloudCatalogClient.ListServicesFixedSizeCollection

CloudCatalogClient.ListServicesPage

CloudCatalogClient.ListServicesPagedResponse