PrivateCatalogAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport] = 'grpc_asyncio', 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>)
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][].
Properties
transport
Returns the transport used by the client instance.
Type | Description |
PrivateCatalogTransport | The transport used by the client instance. |
Methods
PrivateCatalogAsyncClient
PrivateCatalogAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.base.PrivateCatalogTransport] = 'grpc_asyncio', 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>)
Instantiates the private catalog client.
Name | Description |
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,
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 |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
catalog_path
catalog_path(catalog: str)
Returns a fully-qualified catalog string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
PrivateCatalogAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
PrivateCatalogAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
PrivateCatalogAsyncClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
parse_catalog_path
parse_catalog_path(path: str)
Parses a catalog path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_product_path
parse_product_path(path: str)
Parses a product path into its component segments.
parse_version_path
parse_version_path(path: str)
Parses a version path into its component segments.
product_path
product_path(product: str)
Returns a fully-qualified product string.
search_catalogs
search_catalogs(request: Optional[Union[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchCatalogsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Search xref_Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
from google.cloud import privatecatalog_v1beta1
async def sample_search_catalogs():
# Create a client
client = privatecatalog_v1beta1.PrivateCatalogAsyncClient()
# Initialize request argument(s)
request = privatecatalog_v1beta1.SearchCatalogsRequest(
resource="resource_value",
)
# Make the request
page_result = client.search_catalogs(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest, dict]
The request object. Request message for PrivateCatalog.SearchCatalogs. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsAsyncPager | Response message for PrivateCatalog.SearchCatalogs. Iterating over this object will yield results and resolve additional pages automatically. |
search_products
search_products(request: Optional[Union[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchProductsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Search xref_Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
from google.cloud import privatecatalog_v1beta1
async def sample_search_products():
# Create a client
client = privatecatalog_v1beta1.PrivateCatalogAsyncClient()
# Initialize request argument(s)
request = privatecatalog_v1beta1.SearchProductsRequest(
resource="resource_value",
)
# Make the request
page_result = client.search_products(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest, dict]
The request object. Request message for PrivateCatalog.SearchProducts. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsAsyncPager | Response message for PrivateCatalog.SearchProducts. Iterating over this object will yield results and resolve additional pages automatically. |
search_versions
search_versions(request: Optional[Union[google.cloud.privatecatalog_v1beta1.types.private_catalog.SearchVersionsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Search xref_Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
from google.cloud import privatecatalog_v1beta1
async def sample_search_versions():
# Create a client
client = privatecatalog_v1beta1.PrivateCatalogAsyncClient()
# Initialize request argument(s)
request = privatecatalog_v1beta1.SearchVersionsRequest(
resource="resource_value",
query="query_value",
)
# Make the request
page_result = client.search_versions(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest, dict]
The request object. Request message for PrivateCatalog.SearchVersions. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsAsyncPager | Response message for PrivateCatalog.SearchVersions. Iterating over this object will yield results and resolve additional pages automatically. |
version_path
version_path(catalog: str, product: str, version: str)
Returns a fully-qualified version string.