Class CatalogServiceClient (0.10.6rc0)

CatalogServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recommendationengine_v1beta1.services.catalog_service.transports.base.CatalogServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

transport

Returns the transport used by the client instance.

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

Methods

CatalogServiceClient

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

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

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

catalog_item_path_path

catalog_item_path_path(
    project: str, location: str, catalog: str, catalog_item_path: str
) -> str

Returns a fully-qualified catalog_item_path string.

catalog_path

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

Returns a fully-qualified catalog string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_catalog_item

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

Creates a catalog item.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recommendationengine_v1beta1

def sample_create_catalog_item():
    # Create a client
    client = recommendationengine_v1beta1.CatalogServiceClient()

    # Initialize request argument(s)
    catalog_item = recommendationengine_v1beta1.CatalogItem()
    catalog_item.id = "id_value"
    catalog_item.category_hierarchies.categories = ['categories_value1', 'categories_value2']
    catalog_item.title = "title_value"

    request = recommendationengine_v1beta1.CreateCatalogItemRequest(
        parent="parent_value",
        catalog_item=catalog_item,
    )

    # Make the request
    response = client.create_catalog_item(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`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
Type	Description
`google.cloud.recommendationengine_v1beta1.types.CatalogItem`	CatalogItem captures all metadata information of items to be recommended.

delete_catalog_item

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

Deletes a catalog item.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recommendationengine_v1beta1

def sample_delete_catalog_item():
    # Create a client
    client = recommendationengine_v1beta1.CatalogServiceClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.DeleteCatalogItemRequest(
        name="name_value",
    )

    # Make the request
    client.delete_catalog_item(request=request)

Parameters
Name	Description
`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.

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

Returns
Type	Description
`CatalogServiceClient`	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
`CatalogServiceClient`	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
`CatalogServiceClient`	The constructed client.

get_catalog_item

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

Gets a specific catalog item.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recommendationengine_v1beta1

def sample_get_catalog_item():
    # Create a client
    client = recommendationengine_v1beta1.CatalogServiceClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.GetCatalogItemRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_catalog_item(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`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
Type	Description
`google.cloud.recommendationengine_v1beta1.types.CatalogItem`	CatalogItem captures all metadata information of items to be recommended.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.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 variable 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.

import_catalog_items

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

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recommendationengine_v1beta1

def sample_import_catalog_items():
    # Create a client
    client = recommendationengine_v1beta1.CatalogServiceClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.ImportCatalogItemsRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.import_catalog_items(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`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
Type	Description
`google.api_core.operation.Operation`	An 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: typing.Optional[
        typing.Union[
            google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    filter: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager
)

Gets a list of catalog items.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recommendationengine_v1beta1

def sample_list_catalog_items():
    # Create a client
    client = recommendationengine_v1beta1.CatalogServiceClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.ListCatalogItemsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`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
Type	Description
`google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager`	Response message for ListCatalogItems method. Iterating over this object will yield results and resolve additional pages automatically.

parse_catalog_item_path_path

parse_catalog_item_path_path(path: str) -> typing.Dict[str, str]

Parses a catalog_item_path path into its component segments.

parse_catalog_path

parse_catalog_path(path: str) -> typing.Dict[str, str]

Parses a catalog path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

update_catalog_item

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recommendationengine_v1beta1

def sample_update_catalog_item():
    # Create a client
    client = recommendationengine_v1beta1.CatalogServiceClient()

    # Initialize request argument(s)
    catalog_item = recommendationengine_v1beta1.CatalogItem()
    catalog_item.id = "id_value"
    catalog_item.category_hierarchies.categories = ['categories_value1', 'categories_value2']
    catalog_item.title = "title_value"

    request = recommendationengine_v1beta1.UpdateCatalogItemRequest(
        name="name_value",
        catalog_item=catalog_item,
    )

    # Make the request
    response = client.update_catalog_item(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`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
Type	Description
`google.cloud.recommendationengine_v1beta1.types.CatalogItem`	CatalogItem captures all metadata information of items to be recommended.