Package Classes (0.9.12)

Summary of entries of Classes for cloudprivatecatalog.

Classes

PrivateCatalogAsyncClient

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

PrivateCatalogClient

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

SearchCatalogsAsyncPager

A pager for iterating through search_catalogs requests.

This class thinly wraps an initial SearchCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

If there are more pages, the __aiter__ method will make additional SearchCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual SearchCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchCatalogsPager

A pager for iterating through search_catalogs requests.

This class thinly wraps an initial SearchCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

If there are more pages, the __iter__ method will make additional SearchCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual SearchCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchProductsAsyncPager

A pager for iterating through search_products requests.

This class thinly wraps an initial SearchProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional SearchProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual SearchProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchProductsPager

A pager for iterating through search_products requests.

This class thinly wraps an initial SearchProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional SearchProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual SearchProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchVersionsAsyncPager

A pager for iterating through search_versions requests.

This class thinly wraps an initial SearchVersionsResponse object, and provides an __aiter__ method to iterate through its versions field.

If there are more pages, the __aiter__ method will make additional SearchVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual SearchVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchVersionsPager

A pager for iterating through search_versions requests.

This class thinly wraps an initial SearchVersionsResponse object, and provides an __iter__ method to iterate through its versions field.

If there are more pages, the __iter__ method will make additional SearchVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual SearchVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AssetReference

Defines the reference of an asset belonging to a product.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AssetValidationState

Possible validation steates of an asset reference.

Catalog

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

GcsSource

Defines how to access Cloud Storage source.

GitSource

Defines how to access a Git Source.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Inputs

Defines definition of input parameters of asset templates.

Product

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

SearchCatalogsRequest

Request message for PrivateCatalog.SearchCatalogs.

SearchCatalogsResponse

Response message for PrivateCatalog.SearchCatalogs.

SearchProductsRequest

Request message for PrivateCatalog.SearchProducts.

SearchProductsResponse

Response message for PrivateCatalog.SearchProducts.

SearchVersionsRequest

Request message for PrivateCatalog.SearchVersions.

SearchVersionsResponse

Response message for PrivateCatalog.SearchVersions.

Version

The consumer representation of a version which is a child resource under a Product with asset data.

Modules

pagers

API documentation for privatecatalog_v1beta1.services.private_catalog.pagers module.