Class CatalogServiceClient

Service for ingesting catalog information of the customer's website.

Inheritance

builtins.object > CatalogServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
CatalogServiceTransportThe transport used by the client instance.

Methods

__exit__

__exit__(type, value, traceback)

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!

catalog_path

catalog_path(project: str, location: str, catalog: str)

Returns a fully-qualified catalog string.

Parameters
NameDescription
project str
location str
catalog str

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_catalog_item

create_catalog_item(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.catalog_service.CreateCatalogItemRequest, dict]] = None, *, parent: Optional[str] = None, catalog_item: Optional[google.cloud.recommendationengine_v1beta1.types.catalog.CatalogItem] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a catalog item.

Parameters
NameDescription
request Union[google.cloud.recommendationengine_v1beta1.types.CreateCatalogItemRequest, dict]

The request object. Request message for CreateCatalogItem method.

parent str

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

catalog_item google.cloud.recommendationengine_v1beta1.types.CatalogItem

Required. The catalog item to create. This corresponds to the catalog_item 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
TypeDescription
google.cloud.recommendationengine_v1beta1.types.CatalogItemCatalogItem captures all metadata information of items to be recommended.

delete_catalog_item

delete_catalog_item(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.catalog_service.DeleteCatalogItemRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a catalog item.

Parameters
NameDescription
request Union[google.cloud.recommendationengine_v1beta1.types.DeleteCatalogItemRequest, dict]

The request object. Request message for DeleteCatalogItem method.

name str

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id. This corresponds to the name 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.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
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
TypeDescription
CatalogServiceClientThe 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.

Parameters
NameDescription
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
TypeDescription
CatalogServiceClientThe 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.

Parameters
NameDescription
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
TypeDescription
CatalogServiceClientThe constructed client.

get_catalog_item

get_catalog_item(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.catalog_service.GetCatalogItemRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a specific catalog item.

Parameters
NameDescription
request Union[google.cloud.recommendationengine_v1beta1.types.GetCatalogItemRequest, dict]

The request object. Request message for GetCatalogItem method.

name str

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id. This corresponds to the name 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
TypeDescription
google.cloud.recommendationengine_v1beta1.types.CatalogItemCatalogItem captures all metadata information of items to be recommended.

import_catalog_items

import_catalog_items(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.import_.ImportCatalogItemsRequest, dict]] = None, *, parent: Optional[str] = None, request_id: Optional[str] = None, input_config: Optional[google.cloud.recommendationengine_v1beta1.types.import_.InputConfig] = None, errors_config: Optional[google.cloud.recommendationengine_v1beta1.types.import_.ImportErrorsConfig] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Parameters
NameDescription
request Union[google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest, dict]

The request object. Request message for Import methods.

parent str

Required. projects/1234/locations/global/catalogs/default_catalog This corresponds to the parent field on the request instance; if request is provided, this should not be set.

request_id str

Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. This corresponds to the request_id field on the request instance; if request is provided, this should not be set.

input_config google.cloud.recommendationengine_v1beta1.types.InputConfig

Required. The desired input location of the data. This corresponds to the input_config field on the request instance; if request is provided, this should not be set.

errors_config google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig

Optional. The desired location of errors incurred during the Import. This corresponds to the errors_config 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
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ImportCatalogItemsResponse Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

list_catalog_items

list_catalog_items(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest, dict]] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a list of catalog items.

Parameters
NameDescription
request Union[google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest, dict]

The request object. Request message for ListCatalogItems method.

parent str

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

filter str

Optional. A filter to apply on the list results. This corresponds to the filter 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
TypeDescription
google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPagerResponse message for ListCatalogItems method. Iterating over this object will yield results and resolve additional pages automatically.

parse_catalog_path

parse_catalog_path(path: str)

Parses a catalog path into its component segments.

Parameter
NameDescription
path str

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

update_catalog_item

update_catalog_item(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.catalog_service.UpdateCatalogItemRequest, dict]] = None, *, name: Optional[str] = None, catalog_item: Optional[google.cloud.recommendationengine_v1beta1.types.catalog.CatalogItem] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Parameters
NameDescription
request Union[google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest, dict]

The request object. Request message for UpdateCatalogItem method.

name str

Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id This corresponds to the name field on the request instance; if request is provided, this should not be set.

catalog_item google.cloud.recommendationengine_v1beta1.types.CatalogItem

Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'. This corresponds to the catalog_item field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields. 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
TypeDescription
google.cloud.recommendationengine_v1beta1.types.CatalogItemCatalogItem captures all metadata information of items to be recommended.