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.

CatalogService

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

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

Instantiates the catalog service 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, 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.

Raises

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

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

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

Creates a catalog item.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.CreateCatalogItemRequest) – 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

CatalogItem captures all metadata information of items to be recommended.

Return type

google.cloud.recommendationengine_v1beta1.types.CatalogItem

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

Deletes a catalog item.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.DeleteCatalogItemRequest) – 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.

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

CatalogServiceAsyncClient

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

CatalogServiceAsyncClient

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

CatalogServiceAsyncClient

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

Gets a specific catalog item.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.GetCatalogItemRequest) – 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

CatalogItem captures all metadata information of items to be recommended.

Return type

google.cloud.recommendationengine_v1beta1.types.CatalogItem

get_transport_class()Type[google.cloud.recommendationengine_v1beta1.services.catalog_service.transports.base.CatalogServiceTransport]

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.

async import_catalog_items(request: Optional[google.cloud.recommendationengine_v1beta1.types.import_.ImportCatalogItemsRequest] = 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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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
  • request (google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.recommendationengine_v1beta1.types.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.

Return type

google.api_core.operation_async.AsyncOperation

async list_catalog_items(request: Optional[google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager[source]

Gets a list of catalog items.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest) – 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

Response message for ListCatalogItems method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager

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.

property transport: google.cloud.recommendationengine_v1beta1.services.catalog_service.transports.base.CatalogServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

CatalogServiceTransport

async update_catalog_item(request: Optional[google.cloud.recommendationengine_v1beta1.types.catalog_service.UpdateCatalogItemRequest] = 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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.types.catalog.CatalogItem[source]

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

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest) – 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

CatalogItem captures all metadata information of items to be recommended.

Return type

google.cloud.recommendationengine_v1beta1.types.CatalogItem

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

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

Instantiates the catalog service 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, CatalogServiceTransport]) – 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(project: str, location: str, 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.

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.types.catalog.CatalogItem[source]

Creates a catalog item.

Parameters
  • 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

CatalogItem captures all metadata information of items to be recommended.

Return type

google.cloud.recommendationengine_v1beta1.types.CatalogItem

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

Deletes a catalog item.

Parameters
  • 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.

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

CatalogServiceClient

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

CatalogServiceClient

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

CatalogServiceClient

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

Gets a specific catalog item.

Parameters
  • 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

CatalogItem captures all metadata information of items to be recommended.

Return type

google.cloud.recommendationengine_v1beta1.types.CatalogItem

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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
  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.recommendationengine_v1beta1.types.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.

Return type

google.api_core.operation.Operation

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager[source]

Gets a list of catalog items.

Parameters
  • 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

Response message for ListCatalogItems method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager

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.

property transport: google.cloud.recommendationengine_v1beta1.services.catalog_service.transports.base.CatalogServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

CatalogServiceTransport

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.types.catalog.CatalogItem[source]

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

Parameters
  • 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

CatalogItem captures all metadata information of items to be recommended.

Return type

google.cloud.recommendationengine_v1beta1.types.CatalogItem

class google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager(method: Callable[[...], Awaitable[google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse]], request: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest, response: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_catalog_items requests.

This class thinly wraps an initial google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsResponse object, and provides an __aiter__ method to iterate through its catalog_items field.

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

All the usual google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsResponse 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.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager(method: Callable[[...], google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse], request: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest, response: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_catalog_items requests.

This class thinly wraps an initial google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsResponse object, and provides an __iter__ method to iterate through its catalog_items field.

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

All the usual google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsResponse 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