As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

PrivateCatalog

class google.cloud.privatecatalog_v1beta1.services.private_catalog.PrivateCatalogAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the private catalog client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, PrivateCatalogTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static catalog_path(catalog: str)str

Returns a fully-qualified catalog string.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PrivateCatalogAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PrivateCatalogAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PrivateCatalogAsyncClient

get_transport_class()Type[google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

static parse_catalog_path(path: str)Dict[str, str]

Parses a catalog path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_product_path(path: str)Dict[str, str]

Parses a product path into its component segments.

static parse_version_path(path: str)Dict[str, str]

Parses a version path into its component segments.

static product_path(product: str)str

Returns a fully-qualified product string.

async search_catalogs(request: Optional[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsAsyncPager[source]

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

Parameters
Returns

Response message for [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsAsyncPager

async search_products(request: Optional[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsAsyncPager[source]

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

Parameters
Returns

Response message for [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsAsyncPager

async search_versions(request: Optional[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsAsyncPager[source]

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

Parameters
Returns

Response message for [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsAsyncPager

property transport: google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

PrivateCatalogTransport

static version_path(catalog: str, product: str, version: str)str

Returns a fully-qualified version string.

class google.cloud.privatecatalog_v1beta1.services.private_catalog.PrivateCatalogClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the private catalog client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, PrivateCatalogTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static catalog_path(catalog: str)str[source]

Returns a fully-qualified catalog string.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PrivateCatalogClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PrivateCatalogClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PrivateCatalogClient

static parse_catalog_path(path: str)Dict[str, str][source]

Parses a catalog path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_product_path(path: str)Dict[str, str][source]

Parses a product path into its component segments.

static parse_version_path(path: str)Dict[str, str][source]

Parses a version path into its component segments.

static product_path(product: str)str[source]

Returns a fully-qualified product string.

search_catalogs(request: Optional[Union[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsPager[source]

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

Parameters
Returns

Response message for [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsPager

search_products(request: Optional[Union[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsPager[source]

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

Parameters
Returns

Response message for [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsPager

search_versions(request: Optional[Union[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsPager[source]

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

Parameters
Returns

Response message for [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsPager

property transport: google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

PrivateCatalogTransport

static version_path(catalog: str, product: str, version: str)str[source]

Returns a fully-qualified version string.

class google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsAsyncPager(method: Callable[[...], Awaitable[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsResponse]], request: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsRequest, response: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_catalogs requests.

This class thinly wraps an initial google.cloud.privatecatalog_v1beta1.types.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 google.cloud.privatecatalog_v1beta1.types.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.

Instantiates the pager.

Parameters
class google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsPager(method: Callable[[...], google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsResponse], request: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsRequest, response: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_catalogs requests.

This class thinly wraps an initial google.cloud.privatecatalog_v1beta1.types.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 google.cloud.privatecatalog_v1beta1.types.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.

Instantiate the pager.

Parameters
class google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsAsyncPager(method: Callable[[...], Awaitable[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsResponse]], request: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsRequest, response: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_products requests.

This class thinly wraps an initial google.cloud.privatecatalog_v1beta1.types.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 google.cloud.privatecatalog_v1beta1.types.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.

Instantiates the pager.

Parameters
class google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsPager(method: Callable[[...], google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsResponse], request: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsRequest, response: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_products requests.

This class thinly wraps an initial google.cloud.privatecatalog_v1beta1.types.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 google.cloud.privatecatalog_v1beta1.types.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.

Instantiate the pager.

Parameters
class google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsResponse]], request: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsRequest, response: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_versions requests.

This class thinly wraps an initial google.cloud.privatecatalog_v1beta1.types.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 google.cloud.privatecatalog_v1beta1.types.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.

Instantiates the pager.

Parameters
class google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsPager(method: Callable[[...], google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsResponse], request: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsRequest, response: google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_versions requests.

This class thinly wraps an initial google.cloud.privatecatalog_v1beta1.types.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 google.cloud.privatecatalog_v1beta1.types.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.

Instantiate the pager.

Parameters