com.google.cloud.billing.v1

Class CloudCatalogClient

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:

 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:

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 CloudCatalogSettings to create(). For example:

To customize credentials:

 CloudCatalogSettings cloudCatalogSettings =
     CloudCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create(cloudCatalogSettings);
 

To customize the endpoint:

 CloudCatalogSettings cloudCatalogSettings =
     CloudCatalogSettings.newBuilder().setEndpoint(myEndpoint).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

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public CloudCatalogStub getStub()

listServices

public final CloudCatalogClient.ListServicesPagedResponse listServices()

Lists all public cloud services.

Sample code:

 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:

 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:

 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:

 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listSkus

public final CloudCatalogClient.ListSkusPagedResponse listSkus(ServiceName parent)

Lists all publicly available SKUs for a given cloud service.

Sample code:

 try (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ServiceName parent = ServiceName.of("[SERVICE]");
   for (Sku element : cloudCatalogClient.listSkus(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the service. Example: "services/DA34-426B-A397"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSkus

public final CloudCatalogClient.ListSkusPagedResponse listSkus(String parent)

Lists all publicly available SKUs for a given cloud service.

Sample code:

 try (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   String parent = ServiceName.of("[SERVICE]").toString();
   for (Sku element : cloudCatalogClient.listSkus(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the service. Example: "services/DA34-426B-A397"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSkus

public final CloudCatalogClient.ListSkusPagedResponse listSkus(ListSkusRequest request)

Lists all publicly available SKUs for a given cloud service.

Sample code:

 try (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ListSkusRequest request =
       ListSkusRequest.newBuilder()
           .setParent(ServiceName.of("[SERVICE]").toString())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setCurrencyCode("currencyCode1004773790")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Sku element : cloudCatalogClient.listSkus(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

listSkusPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSkusRequest,CloudCatalogClient.ListSkusPagedResponse> listSkusPagedCallable()

Lists all publicly available SKUs for a given cloud service.

Sample code:

 try (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ListSkusRequest request =
       ListSkusRequest.newBuilder()
           .setParent(ServiceName.of("[SERVICE]").toString())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setCurrencyCode("currencyCode1004773790")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Sku> future = cloudCatalogClient.listSkusPagedCallable().futureCall(request);
   // Do something.
   for (Sku element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSkusCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSkusRequest,ListSkusResponse> listSkusCallable()

Lists all publicly available SKUs for a given cloud service.

Sample code:

 try (CloudCatalogClient cloudCatalogClient = CloudCatalogClient.create()) {
   ListSkusRequest request =
       ListSkusRequest.newBuilder()
           .setParent(ServiceName.of("[SERVICE]").toString())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setCurrencyCode("currencyCode1004773790")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSkusResponse response = cloudCatalogClient.listSkusCallable().call(request);
     for (Sku element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException