Package com.google.cloud.privatecatalog.v1beta1

Class PrivateCatalogClient

java.lang.Object
com.google.cloud.privatecatalog.v1beta1.PrivateCatalogClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class PrivateCatalogClient extends Object implements BackgroundResource
Service Description: `PrivateCatalog` allows catalog consumers to retrieve `Catalog`, `Product` and `Version` resources under a target resource context.

`Catalog` is computed based on the [Association][]s linked to the target resource and its ancestors. Each association's [google.cloud.privatecatalogproducer.v1beta.Catalog][] is transformed into a `Catalog`. If multiple associations have the same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], they are de-duplicated into one `Catalog`. Users must have `cloudprivatecatalog.catalogTargets.get` IAM permission on the resource context in order to access catalogs. `Catalog` contains the resource name and a subset of data of the original [google.cloud.privatecatalogproducer.v1beta.Catalog][].

`Product` is child resource of the catalog. A `Product` contains the resource name and a subset of the data of the original [google.cloud.privatecatalogproducer.v1beta.Product][].

`Version` is child resource of the product. A `Version` contains the resource name and a subset of the data of the original [google.cloud.privatecatalogproducer.v1beta.Version][].

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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchCatalogsRequest request =
       SearchCatalogsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Catalog element : privateCatalogClient.searchCatalogs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

SearchCatalogs

Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchCatalogs(SearchCatalogsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchCatalogsPagedCallable()

  • searchCatalogsCallable()

SearchProducts

Search [Product][google.cloud.privatecatalog.v1beta1.Product] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchProducts(SearchProductsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchProductsPagedCallable()

  • searchProductsCallable()

SearchVersions

Search [Version][google.cloud.privatecatalog.v1beta1.Version] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchVersions(SearchVersionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchVersionsPagedCallable()

  • searchVersionsCallable()

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 PrivateCatalogSettings 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
 PrivateCatalogSettings privateCatalogSettings =
     PrivateCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create(privateCatalogSettings);

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
 PrivateCatalogSettings privateCatalogSettings =
     PrivateCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
 PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create(privateCatalogSettings);

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
 PrivateCatalogSettings privateCatalogSettings =
     PrivateCatalogSettings.newHttpJsonBuilder().build();
 PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create(privateCatalogSettings);

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

  • Constructor Details

    • PrivateCatalogClient

      protected PrivateCatalogClient(PrivateCatalogSettings settings) throws IOException
      Constructs an instance of PrivateCatalogClient, 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

    • PrivateCatalogClient

      protected PrivateCatalogClient(PrivateCatalogStub stub)

  • Method Details

    • create

      public static final PrivateCatalogClient create() throws IOException
      Constructs an instance of PrivateCatalogClient with default settings.
      Throws:
      IOException

    • create

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

    • getSettings

      public final PrivateCatalogSettings getSettings()

    • getStub

      public PrivateCatalogStub getStub()

    • searchCatalogs

      public final PrivateCatalogClient.SearchCatalogsPagedResponse searchCatalogs(SearchCatalogsRequest request)
      Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchCatalogsRequest request =
       SearchCatalogsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Catalog element : privateCatalogClient.searchCatalogs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • searchCatalogsPagedCallable

      public final UnaryCallable<SearchCatalogsRequest,PrivateCatalogClient.SearchCatalogsPagedResponse> searchCatalogsPagedCallable()
      Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchCatalogsRequest request =
       SearchCatalogsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Catalog> future =
       privateCatalogClient.searchCatalogsPagedCallable().futureCall(request);
   // Do something.
   for (Catalog element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • searchCatalogsCallable

      public final UnaryCallable<SearchCatalogsRequest,SearchCatalogsResponse> searchCatalogsCallable()
      Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchCatalogsRequest request =
       SearchCatalogsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchCatalogsResponse response =
         privateCatalogClient.searchCatalogsCallable().call(request);
     for (Catalog element : response.getCatalogsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • searchProducts

      public final PrivateCatalogClient.SearchProductsPagedResponse searchProducts(SearchProductsRequest request)
      Search [Product][google.cloud.privatecatalog.v1beta1.Product] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchProductsRequest request =
       SearchProductsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Product element : privateCatalogClient.searchProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • searchProductsPagedCallable

      public final UnaryCallable<SearchProductsRequest,PrivateCatalogClient.SearchProductsPagedResponse> searchProductsPagedCallable()
      Search [Product][google.cloud.privatecatalog.v1beta1.Product] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchProductsRequest request =
       SearchProductsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Product> future =
       privateCatalogClient.searchProductsPagedCallable().futureCall(request);
   // Do something.
   for (Product element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • searchProductsCallable

      public final UnaryCallable<SearchProductsRequest,SearchProductsResponse> searchProductsCallable()
      Search [Product][google.cloud.privatecatalog.v1beta1.Product] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchProductsRequest request =
       SearchProductsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchProductsResponse response =
         privateCatalogClient.searchProductsCallable().call(request);
     for (Product element : response.getProductsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • searchVersions

      public final PrivateCatalogClient.SearchVersionsPagedResponse searchVersions(SearchVersionsRequest request)
      Search [Version][google.cloud.privatecatalog.v1beta1.Version] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchVersionsRequest request =
       SearchVersionsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Version element : privateCatalogClient.searchVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • searchVersionsPagedCallable

      public final UnaryCallable<SearchVersionsRequest,PrivateCatalogClient.SearchVersionsPagedResponse> searchVersionsPagedCallable()
      Search [Version][google.cloud.privatecatalog.v1beta1.Version] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchVersionsRequest request =
       SearchVersionsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Version> future =
       privateCatalogClient.searchVersionsPagedCallable().futureCall(request);
   // Do something.
   for (Version element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • searchVersionsCallable

      public final UnaryCallable<SearchVersionsRequest,SearchVersionsResponse> searchVersionsCallable()
      Search [Version][google.cloud.privatecatalog.v1beta1.Version] resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

      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 (PrivateCatalogClient privateCatalogClient = PrivateCatalogClient.create()) {
   SearchVersionsRequest request =
       SearchVersionsRequest.newBuilder()
           .setResource("resource-341064690")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchVersionsResponse response =
         privateCatalogClient.searchVersionsCallable().call(request);
     for (Version element : response.getVersionsList()) {
       // 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 BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException