Package com.google.cloud.privatecatalog.v1beta1 (0.29.0)

A client to Cloud Private Catalog API

The interfaces provided are listed below, along with usage samples.

PrivateCatalogClient

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

Sample for PrivateCatalogClient:


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

Classes

AssetReference

Defines the reference of an asset belonging to a product.

Protobuf type google.cloud.privatecatalog.v1beta1.AssetReference

AssetReference.Builder

Defines the reference of an asset belonging to a product.

Protobuf type google.cloud.privatecatalog.v1beta1.AssetReference

Catalog

The readonly representation of a catalog computed with a given resource context.

Protobuf type google.cloud.privatecatalog.v1beta1.Catalog

Catalog.Builder

The readonly representation of a catalog computed with a given resource context.

Protobuf type google.cloud.privatecatalog.v1beta1.Catalog

GcsSource

Defines how to access Cloud Storage source.

Protobuf type google.cloud.privatecatalog.v1beta1.GcsSource

GcsSource.Builder

Defines how to access Cloud Storage source.

Protobuf type google.cloud.privatecatalog.v1beta1.GcsSource

GitSource

Defines how to access a Git Source.

Protobuf type google.cloud.privatecatalog.v1beta1.GitSource

GitSource.Builder

Defines how to access a Git Source.

Protobuf type google.cloud.privatecatalog.v1beta1.GitSource

Inputs

Defines definition of input parameters of asset templates.

Protobuf type google.cloud.privatecatalog.v1beta1.Inputs

Inputs.Builder

Defines definition of input parameters of asset templates.

Protobuf type google.cloud.privatecatalog.v1beta1.Inputs

PrivateCatalogClient

Service Description: PrivateCatalog allows catalog consumers to retrieve Catalog, Product and Version resources under a target resource context.

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

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

PrivateCatalogClient.SearchCatalogsFixedSizeCollection

PrivateCatalogClient.SearchCatalogsPage

PrivateCatalogClient.SearchCatalogsPagedResponse

PrivateCatalogClient.SearchProductsFixedSizeCollection

PrivateCatalogClient.SearchProductsPage

PrivateCatalogClient.SearchProductsPagedResponse

PrivateCatalogClient.SearchVersionsFixedSizeCollection

PrivateCatalogClient.SearchVersionsPage

PrivateCatalogClient.SearchVersionsPagedResponse

PrivateCatalogGrpc

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

PrivateCatalogGrpc.PrivateCatalogBlockingStub

A stub to allow clients to do synchronous rpc calls to service PrivateCatalog.

PrivateCatalogGrpc.PrivateCatalogFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service PrivateCatalog.

PrivateCatalogGrpc.PrivateCatalogImplBase

Base class for the server implementation of the service PrivateCatalog.

PrivateCatalogGrpc.PrivateCatalogStub

A stub to allow clients to do asynchronous rpc calls to service PrivateCatalog.

PrivateCatalogProto

PrivateCatalogSettings

Settings class to configure an instance of PrivateCatalogClient.

The default instance has everything set to sensible defaults:

The default service address (cloudprivatecatalog.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of searchCatalogs to 30 seconds:


 // 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.Builder privateCatalogSettingsBuilder =
     PrivateCatalogSettings.newBuilder();
 privateCatalogSettingsBuilder
     .searchCatalogsSettings()
     .setRetrySettings(
         privateCatalogSettingsBuilder
             .searchCatalogsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PrivateCatalogSettings privateCatalogSettings = privateCatalogSettingsBuilder.build();

Package com.google.cloud.privatecatalog.v1beta1 (0.29.0)

PrivateCatalogClient

Classes

Interfaces

Enums