Class CatalogServiceAsyncClient (1.7.0)

CatalogServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport] = '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>)

Service for managing catalog configuration.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`CatalogServiceTransport`	The transport used by the client instance.

Methods

CatalogServiceAsyncClient

CatalogServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.retail_v2.services.catalog_service.transports.base.CatalogServiceTransport] = '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 catalog service client.

Parameters
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, .CatalogServiceTransport]` 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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

branch_path

branch_path(project: str, location: str, catalog: str, branch: str)

Returns a fully-qualified branch string.

catalog_path

catalog_path(project: str, location: str, 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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`CatalogServiceAsyncClient`	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.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`CatalogServiceAsyncClient`	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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`CatalogServiceAsyncClient`	The constructed client.

get_default_branch

get_default_branch(request: Optional[Union[google.cloud.retail_v2.types.catalog_service.GetDefaultBranchRequest, dict]] = None, *, catalog: Optional[str] = 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]] = ())

Get which branch is currently default branch set by xref_CatalogService.SetDefaultBranch method under a specified parent catalog.

from google.cloud import retail_v2

async def sample_get_default_branch():
    # Create a client
    client = retail_v2.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2.GetDefaultBranchRequest(
    )

    # Make the request
    response = await client.get_default_branch(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2.types.GetDefaultBranchRequest, dict]` The request object. Request message to show which branch is currently the default branch.
`catalog`	`str` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. This corresponds to the `catalog` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.retail_v2.types.GetDefaultBranchResponse`	Response message of CatalogService.GetDefaultBranch.

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.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

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

list_catalogs

list_catalogs(request: Optional[Union[google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest, dict]] = None, *, parent: Optional[str] = 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]] = ())

Lists all the xref_Catalogs associated with the project.

from google.cloud import retail_v2

async def sample_list_catalogs():
    # Create a client
    client = retail_v2.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2.ListCatalogsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_catalogs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2.types.ListCatalogsRequest, dict]` The request object. Request for CatalogService.ListCatalogs method.
`parent`	`str` Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.retail_v2.services.catalog_service.pagers.ListCatalogsAsyncPager`	Response for CatalogService.ListCatalogs method. Iterating over this object will yield results and resolve additional pages automatically.

parse_branch_path

parse_branch_path(path: str)

Parses a branch path into its component segments.

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.

set_default_branch

set_default_branch(request: Optional[Union[google.cloud.retail_v2.types.catalog_service.SetDefaultBranchRequest, dict]] = None, *, catalog: Optional[str] = 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]] = ())

Set a specified branch id as default branch. API methods such as xref_SearchService.Search, xref_ProductService.GetProduct, xref_ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default.

For example, if projects/*/locations/*/catalogs/*/branches/1 is set as default, setting xref_SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting xref_SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/1.

Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/*/locations/*/catalogs/*/branches/default_branch as xref_SearchRequest.branch to route the traffic to this staging branch.

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

from google.cloud import retail_v2

async def sample_set_default_branch():
    # Create a client
    client = retail_v2.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2.SetDefaultBranchRequest(
    )

    # Make the request
    await client.set_default_branch(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2.types.SetDefaultBranchRequest, dict]` The request object. Request message to set a specified branch as new default_branch.
`catalog`	`str` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`. This corresponds to the `catalog` field on the `request` instance; if `request` is provided, this should not be set.
`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.

update_catalog

update_catalog(request: Optional[Union[google.cloud.retail_v2.types.catalog_service.UpdateCatalogRequest, dict]] = None, *, catalog: Optional[google.cloud.retail_v2.types.catalog.Catalog] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())

Updates the xref_Catalogs.

from google.cloud import retail_v2

async def sample_update_catalog():
    # Create a client
    client = retail_v2.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    catalog = retail_v2.Catalog()
    catalog.name = "name_value"
    catalog.display_name = "display_name_value"

    request = retail_v2.UpdateCatalogRequest(
        catalog=catalog,
    )

    # Make the request
    response = await client.update_catalog(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.retail_v2.types.UpdateCatalogRequest, dict]` The request object. Request for CatalogService.UpdateCatalog method.
`catalog`	`Catalog` Required. The Catalog to update. If the caller does not have permission to update the Catalog, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Catalog to update does not exist, a NOT_FOUND error is returned. This corresponds to the `catalog` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.retail_v2.types.Catalog`	The catalog configuration.