Class PrivateCatalogClient (0.38.0)

Version 0.38.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.3.7

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

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

Inheritance

java.lang.Object > PrivateCatalogClient

Static Methods

create()

public static final PrivateCatalogClient create()

Constructs an instance of PrivateCatalogClient with default settings.

Returns
Type	Description
PrivateCatalogClient

Exceptions
Type	Description
IOException

create(PrivateCatalogSettings settings)

public static final PrivateCatalogClient create(PrivateCatalogSettings settings)

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.

Parameter
Name	Description
settings	PrivateCatalogSettings

Returns
Type	Description
PrivateCatalogClient

Exceptions
Type	Description
IOException

create(PrivateCatalogStub stub)

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

Parameter
Name	Description
stub	PrivateCatalogStub

Returns
Type	Description
PrivateCatalogClient

Constructors

PrivateCatalogClient(PrivateCatalogSettings settings)

protected PrivateCatalogClient(PrivateCatalogSettings settings)

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.

Parameter
Name	Description
settings	PrivateCatalogSettings

PrivateCatalogClient(PrivateCatalogStub stub)

protected PrivateCatalogClient(PrivateCatalogStub stub)

Parameter
Name	Description
stub	PrivateCatalogStub

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 PrivateCatalogSettings getSettings()

Returns
Type	Description
PrivateCatalogSettings

getStub()

public PrivateCatalogStub getStub()

Returns
Type	Description
PrivateCatalogStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

searchCatalogs(SearchCatalogsRequest request)

public final PrivateCatalogClient.SearchCatalogsPagedResponse searchCatalogs(SearchCatalogsRequest request)

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

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

Returns
Type	Description
PrivateCatalogClient.SearchCatalogsPagedResponse

searchCatalogsCallable()

public final UnaryCallable<SearchCatalogsRequest,SearchCatalogsResponse> searchCatalogsCallable()

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

Returns
Type	Description
UnaryCallable<SearchCatalogsRequest,SearchCatalogsResponse>

searchCatalogsPagedCallable()

public final UnaryCallable<SearchCatalogsRequest,PrivateCatalogClient.SearchCatalogsPagedResponse> searchCatalogsPagedCallable()

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

Returns
Type	Description
UnaryCallable<SearchCatalogsRequest,SearchCatalogsPagedResponse>

searchProducts(SearchProductsRequest request)

public final PrivateCatalogClient.SearchProductsPagedResponse searchProducts(SearchProductsRequest request)

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

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

Returns
Type	Description
PrivateCatalogClient.SearchProductsPagedResponse

searchProductsCallable()

public final UnaryCallable<SearchProductsRequest,SearchProductsResponse> searchProductsCallable()

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

Returns
Type	Description
UnaryCallable<SearchProductsRequest,SearchProductsResponse>

searchProductsPagedCallable()

public final UnaryCallable<SearchProductsRequest,PrivateCatalogClient.SearchProductsPagedResponse> searchProductsPagedCallable()

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

Returns
Type	Description
UnaryCallable<SearchProductsRequest,SearchProductsPagedResponse>

searchVersions(SearchVersionsRequest request)

public final PrivateCatalogClient.SearchVersionsPagedResponse searchVersions(SearchVersionsRequest request)

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

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

Returns
Type	Description
PrivateCatalogClient.SearchVersionsPagedResponse

searchVersionsCallable()

public final UnaryCallable<SearchVersionsRequest,SearchVersionsResponse> searchVersionsCallable()

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

Returns
Type	Description
UnaryCallable<SearchVersionsRequest,SearchVersionsResponse>

searchVersionsPagedCallable()

public final UnaryCallable<SearchVersionsRequest,PrivateCatalogClient.SearchVersionsPagedResponse> searchVersionsPagedCallable()

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

Returns
Type	Description
UnaryCallable<SearchVersionsRequest,SearchVersionsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()