CloudCatalogClient (Google Cloud Billing 2.71.0 API)

java.lang.Object
- com.google.cloud.billing.v1.CloudCatalogClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class CloudCatalogClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

Methods
Method	Description	Method Variants
ListServices	Lists all public cloud services.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listServices(ListServicesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listServices() Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listServicesPagedCallable() listServicesCallable()
ListSkus	Lists all publicly available SKUs for a given cloud service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSkus(ListSkusRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSkus(ServiceName parent) listSkus(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSkusPagedCallable() listSkusCallable()

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CloudCatalogClient.ListServicesFixedSizeCollection`
`static class`	`CloudCatalogClient.ListServicesPage`
`static class`	`CloudCatalogClient.ListServicesPagedResponse`
`static class`	`CloudCatalogClient.ListSkusFixedSizeCollection`
`static class`	`CloudCatalogClient.ListSkusPage`
`static class`	`CloudCatalogClient.ListSkusPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CloudCatalogClient(CloudCatalogSettings settings)` Constructs an instance of CloudCatalogClient, using the given settings.
`protected`	`CloudCatalogClient(CloudCatalogStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static CloudCatalogClient`	`create()` Constructs an instance of CloudCatalogClient with default settings.
`static CloudCatalogClient`	`create(CloudCatalogSettings settings)` Constructs an instance of CloudCatalogClient, using the given settings.
`static CloudCatalogClient`	`create(CloudCatalogStub stub)` Constructs an instance of CloudCatalogClient, using the given stub for making calls.
`CloudCatalogSettings`	`getSettings()`
`CloudCatalogStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`CloudCatalogClient.ListServicesPagedResponse`	`listServices()` Lists all public cloud services.
`CloudCatalogClient.ListServicesPagedResponse`	`listServices(ListServicesRequest request)` Lists all public cloud services.
`com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ListServicesResponse>`	`listServicesCallable()` Lists all public cloud services.
`com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,CloudCatalogClient.ListServicesPagedResponse>`	`listServicesPagedCallable()` Lists all public cloud services.
`CloudCatalogClient.ListSkusPagedResponse`	`listSkus(ListSkusRequest request)` Lists all publicly available SKUs for a given cloud service.
`CloudCatalogClient.ListSkusPagedResponse`	`listSkus(ServiceName parent)` Lists all publicly available SKUs for a given cloud service.
`CloudCatalogClient.ListSkusPagedResponse`	`listSkus(String parent)` Lists all publicly available SKUs for a given cloud service.
`com.google.api.gax.rpc.UnaryCallable<ListSkusRequest,ListSkusResponse>`	`listSkusCallable()` Lists all publicly available SKUs for a given cloud service.
`com.google.api.gax.rpc.UnaryCallable<ListSkusRequest,CloudCatalogClient.ListSkusPagedResponse>`	`listSkusPagedCallable()` Lists all publicly available SKUs for a given cloud service.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CloudCatalogClient
```
protected CloudCatalogClient(CloudCatalogSettings settings)
                      throws IOException
```
  Constructs an instance of CloudCatalogClient, 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
- CloudCatalogClient
```
protected CloudCatalogClient(CloudCatalogStub stub)
```

Method Detail

create

public static final CloudCatalogClient create()
                                       throws IOException

Constructs an instance of CloudCatalogClient with default settings.

Throws:: IOException

create
```
public static final CloudCatalogClient create(CloudCatalogSettings settings)
                                       throws IOException
```
Constructs an instance of CloudCatalogClient, 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
```
public static final CloudCatalogClient create(CloudCatalogStub stub)
```
Constructs an instance of CloudCatalogClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudCatalogSettings).

getSettings

public final CloudCatalogSettings getSettings()

getStub
```
public CloudCatalogStub getStub()
```

listServices

public final CloudCatalogClient.ListServicesPagedResponse listServices()

Lists all public cloud services.

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

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listServices

public final CloudCatalogClient.ListServicesPagedResponse listServices(ListServicesRequest request)

Lists all public cloud services.

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 (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Service element : cloudCatalogClient.listServices(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listServicesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,CloudCatalogClient.ListServicesPagedResponse> listServicesPagedCallable()

Lists all public cloud services.

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 (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Service> future =
       cloudCatalogClient.listServicesPagedCallable().futureCall(request);
   // Do something.
   for (Service element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listServicesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()

Lists all public cloud services.

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 (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListServicesResponse response = cloudCatalogClient.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;
     }
   }
 }