Class CloudCatalogClient (2.17.0)

public class CloudCatalogClient implements 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().

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

Inheritance

java.lang.Object > CloudCatalogClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final CloudCatalogClient create()

Constructs an instance of CloudCatalogClient with default settings.

Returns
Type	Description
`CloudCatalogClient`

Exceptions
Type	Description
`IOException`

create(CloudCatalogSettings settings)

public static final CloudCatalogClient create(CloudCatalogSettings settings)

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.

Parameter
Name	Description
`settings`	`CloudCatalogSettings`

Returns
Type	Description
`CloudCatalogClient`

Exceptions
Type	Description
`IOException`

create(CloudCatalogStub stub)

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

Parameter
Name	Description
`stub`	`CloudCatalogStub`

Returns
Type	Description
`CloudCatalogClient`

Constructors

CloudCatalogClient(CloudCatalogSettings settings)

protected CloudCatalogClient(CloudCatalogSettings settings)

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.

Parameter
Name	Description
`settings`	`CloudCatalogSettings`

CloudCatalogClient(CloudCatalogStub stub)

protected CloudCatalogClient(CloudCatalogStub stub)

Parameter
Name	Description
`stub`	`CloudCatalogStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getSettings()

public final CloudCatalogSettings getSettings()

Returns
Type	Description
`CloudCatalogSettings`

getStub()

public CloudCatalogStub getStub()

Returns
Type	Description
`CloudCatalogStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

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

Returns
Type	Description
`CloudCatalogClient.ListServicesPagedResponse`

listServices(ListServicesRequest request)

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

Parameter
Name	Description
`request`	`ListServicesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudCatalogClient.ListServicesPagedResponse`

listServicesCallable()

public final 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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListServicesRequest,ListServicesResponse>`

listServicesPagedCallable()

public final 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);
   }
 }

Returns
Type	Description
`UnaryCallable<ListServicesRequest,ListServicesPagedResponse>`

listSkus(ListSkusRequest request)

public final CloudCatalogClient.ListSkusPagedResponse listSkus(ListSkusRequest request)

Lists all publicly available SKUs for a given cloud service.

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

Parameter
Name	Description
`request`	`ListSkusRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudCatalogClient.ListSkusPagedResponse`

listSkus(ServiceName parent)

public final CloudCatalogClient.ListSkusPagedResponse listSkus(ServiceName parent)

Lists all publicly available SKUs for a given cloud service.

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()) {
   ServiceName parent = ServiceName.of("[SERVICE]");
   for (Sku element : cloudCatalogClient.listSkus(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`ServiceName` Required. The name of the service. Example: "services/DA34-426B-A397"

Returns
Type	Description
`CloudCatalogClient.ListSkusPagedResponse`

listSkus(String parent)

public final CloudCatalogClient.ListSkusPagedResponse listSkus(String parent)

Lists all publicly available SKUs for a given cloud service.

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()) {
   String parent = ServiceName.of("[SERVICE]").toString();
   for (Sku element : cloudCatalogClient.listSkus(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The name of the service. Example: "services/DA34-426B-A397"

Returns
Type	Description
`CloudCatalogClient.ListSkusPagedResponse`

listSkusCallable()

public final UnaryCallable<ListSkusRequest,ListSkusResponse> listSkusCallable()

Lists all publicly available SKUs for a given cloud service.

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

Returns
Type	Description
`UnaryCallable<ListSkusRequest,ListSkusResponse>`

listSkusPagedCallable()

public final UnaryCallable<ListSkusRequest,CloudCatalogClient.ListSkusPagedResponse> listSkusPagedCallable()

Lists all publicly available SKUs for a given cloud service.

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

Returns
Type	Description
`UnaryCallable<ListSkusRequest,ListSkusPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()