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

Instantiates the catalog service async 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 (Optional[Union[str,CatalogServiceTransport,Callable[..., CatalogServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the CatalogServiceTransport constructor. 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.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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

async add_catalog_attribute(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.AddCatalogAttributeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Adds the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned.

# 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 retail_v2alpha

async def sample_add_catalog_attribute():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    catalog_attribute = retail_v2alpha.CatalogAttribute()
    catalog_attribute.key = "key_value"

    request = retail_v2alpha.AddCatalogAttributeRequest(
        attributes_config="attributes_config_value",
        catalog_attribute=catalog_attribute,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.AddCatalogAttributeRequest, dict]]) – The request object. Request for [CatalogService.AddCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.AddCatalogAttribute] method.

• retry (google.api_core.retry_async.AsyncRetry) – 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static attributes_config_path(project: str, location: str, catalog: str) → str

Returns a fully-qualified attributes_config string.

async batch_remove_catalog_attributes(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesResponse

Removes all specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s from the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

# 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 retail_v2alpha

async def sample_batch_remove_catalog_attributes():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.BatchRemoveCatalogAttributesRequest(
        attributes_config="attributes_config_value",
        attribute_keys=['attribute_keys_value1', 'attribute_keys_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.BatchRemoveCatalogAttributesRequest, dict]]) – The request object. Request for [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes] method.

• retry (google.api_core.retry_async.AsyncRetry) – 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 of the

[CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes].

Return type

google.cloud.retail_v2alpha.types.BatchRemoveCatalogAttributesResponse

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

Returns a fully-qualified branch string.

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.

static completion_config_path(project: str, location: str, catalog: str) → str

Returns a fully-qualified completion_config string.

classmethod from_service_account_file(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

classmethod from_service_account_info(info: dict, *args, **kwargs)

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_attributes_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.GetAttributesConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Gets an [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

# 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 retail_v2alpha

async def sample_get_attributes_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetAttributesConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.GetAttributesConfigRequest, dict]]) – The request object. Request for [CatalogService.GetAttributesConfig][google.cloud.retail.v2alpha.CatalogService.GetAttributesConfig] method.

• name (str) –

  Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

async get_completion_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.GetCompletionConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.CompletionConfig

Gets a [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig].

# 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 retail_v2alpha

async def sample_get_completion_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetCompletionConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.GetCompletionConfigRequest, dict]]) – The request object. Request for [CatalogService.GetCompletionConfig][google.cloud.retail.v2alpha.CatalogService.GetCompletionConfig] method.

• name (str) –

  Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – 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

Catalog level autocomplete config for customers to customize autocomplete feature’s settings.

Return type

google.cloud.retail_v2alpha.types.CompletionConfig

async get_default_branch(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchRequest, dict]] = None, *, catalog: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.SetDefaultBranch] method under a specified parent catalog.

# 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 retail_v2alpha

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

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

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.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_async.AsyncRetry) – 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 of

[CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch].

Return type

google.cloud.retail_v2alpha.types.GetDefaultBranchResponse

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

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters

• request (GetOperationRequest) – The request object. Request message for GetOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – 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 Operation object.

Return type

Operation

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.retail_v2alpha.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 list_catalogs(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsAsyncPager

Lists all the [Catalog][google.cloud.retail.v2alpha.Catalog]s associated with the project.

# 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 retail_v2alpha

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

    # Initialize request argument(s)
    request = retail_v2alpha.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

• request (Optional[Union[google.cloud.retail_v2alpha.types.ListCatalogsRequest, dict]]) – The request object. Request for [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] method.

• parent (str) –

  Required. The account resource name with an associated location.

  If the caller does not have permission to list [Catalog][google.cloud.retail.v2alpha.Catalog]s 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_async.AsyncRetry) – 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 for

[CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsAsyncPager

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters

• request (ListOperationsRequest) – The request object. Request message for ListOperations method.

• retry (google.api_core.retry_async.AsyncRetry) – 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 ListOperations method.

Return type

ListOperationsResponse

static parse_attributes_config_path(path: str) → Dict[str, str]

Parses a attributes_config path into its component segments.

static parse_branch_path(path: str) → Dict[str, str]

Parses a branch path into its component segments.

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.

static parse_completion_config_path(path: str) → Dict[str, str]

Parses a completion_config path into its component segments.

async remove_catalog_attribute(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.RemoveCatalogAttributeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Removes the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned.

# 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 retail_v2alpha

async def sample_remove_catalog_attribute():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.RemoveCatalogAttributeRequest(
        attributes_config="attributes_config_value",
        key="key_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.RemoveCatalogAttributeRequest, dict]]) – The request object. Request for [CatalogService.RemoveCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.RemoveCatalogAttribute] method.

• retry (google.api_core.retry_async.AsyncRetry) – 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

async replace_catalog_attribute(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.ReplaceCatalogAttributeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Replaces the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] in the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] by updating the catalog attribute with the same [CatalogAttribute.key][google.cloud.retail.v2alpha.CatalogAttribute.key].

If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to replace does not exist, a NOT_FOUND error is returned.

# 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 retail_v2alpha

async def sample_replace_catalog_attribute():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    catalog_attribute = retail_v2alpha.CatalogAttribute()
    catalog_attribute.key = "key_value"

    request = retail_v2alpha.ReplaceCatalogAttributeRequest(
        attributes_config="attributes_config_value",
        catalog_attribute=catalog_attribute,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.ReplaceCatalogAttributeRequest, dict]]) – The request object. Request for [CatalogService.ReplaceCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.ReplaceCatalogAttribute] method.

• retry (google.api_core.retry_async.AsyncRetry) – 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

async set_default_branch(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.SetDefaultBranchRequest, dict]] = None, *, catalog: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Set a specified branch id as default branch. API methods such as [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search], [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct], [ProductService.ListProducts][google.cloud.retail.v2alpha.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 [SearchRequest.branch][google.cloud.retail.v2alpha.SearchRequest.branch] to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting [SearchRequest.branch][google.cloud.retail.v2alpha.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 [SearchRequest.branch][google.cloud.retail.v2alpha.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}.

# 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 retail_v2alpha

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

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

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

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.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_async.AsyncRetry) – 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.

property transport: google.cloud.retail_v2alpha.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

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async update_attributes_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.UpdateAttributesConfigRequest, dict]] = None, *, attributes_config: Optional[google.cloud.retail_v2alpha.types.catalog.AttributesConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Updates the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

# 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 retail_v2alpha

async def sample_update_attributes_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    attributes_config = retail_v2alpha.AttributesConfig()
    attributes_config.name = "name_value"

    request = retail_v2alpha.UpdateAttributesConfigRequest(
        attributes_config=attributes_config,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.UpdateAttributesConfigRequest, dict]]) – The request object. Request for [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2alpha.CatalogService.UpdateAttributesConfig] method.

• attributes_config (google.cloud.retail_v2alpha.types.AttributesConfig) –

  Required. The [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] to update.

  This corresponds to the attributes_config 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 [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] to update. The following is the only supported field:

  • [AttributesConfig.catalog_attributes][google.cloud.retail.v2alpha.AttributesConfig.catalog_attributes]

  If not set, all supported fields are updated.

  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_async.AsyncRetry) – 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

async update_catalog(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.UpdateCatalogRequest, dict]] = None, *, catalog: Optional[google.cloud.retail_v2alpha.types.catalog.Catalog] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.Catalog

Updates the [Catalog][google.cloud.retail.v2alpha.Catalog]s.

# 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 retail_v2alpha

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

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

    request = retail_v2alpha.UpdateCatalogRequest(
        catalog=catalog,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.UpdateCatalogRequest, dict]]) – The request object. Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2alpha.CatalogService.UpdateCatalog] method.

• catalog (google.cloud.retail_v2alpha.types.Catalog) –

  Required. The [Catalog][google.cloud.retail.v2alpha.Catalog] to update.

  If the caller does not have permission to update the [Catalog][google.cloud.retail.v2alpha.Catalog], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  If the [Catalog][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.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_async.AsyncRetry) – 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

The catalog configuration.

Return type

google.cloud.retail_v2alpha.types.Catalog

async update_completion_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.UpdateCompletionConfigRequest, dict]] = None, *, completion_config: Optional[google.cloud.retail_v2alpha.types.catalog.CompletionConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.CompletionConfig

Updates the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig]s.

# 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 retail_v2alpha

async def sample_update_completion_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceAsyncClient()

    # Initialize request argument(s)
    completion_config = retail_v2alpha.CompletionConfig()
    completion_config.name = "name_value"

    request = retail_v2alpha.UpdateCompletionConfigRequest(
        completion_config=completion_config,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.retail_v2alpha.types.UpdateCompletionConfigRequest, dict]]) – The request object. Request for [CatalogService.UpdateCompletionConfig][google.cloud.retail.v2alpha.CatalogService.UpdateCompletionConfig] method.

• completion_config (google.cloud.retail_v2alpha.types.CompletionConfig) –

  Required. The [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig] to update.

  If the caller does not have permission to update the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig], then a PERMISSION_DENIED error is returned.

  If the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig] to update does not exist, a NOT_FOUND error is returned.

  This corresponds to the completion_config 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 [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig] to update. The following are the only supported fields:

  • [CompletionConfig.matching_order][google.cloud.retail.v2alpha.CompletionConfig.matching_order]

  • [CompletionConfig.max_suggestions][google.cloud.retail.v2alpha.CompletionConfig.max_suggestions]

  • [CompletionConfig.min_prefix_length][google.cloud.retail.v2alpha.CompletionConfig.min_prefix_length]

  • [CompletionConfig.auto_learning][google.cloud.retail.v2alpha.CompletionConfig.auto_learning]

  If not set, all supported fields are updated.

  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_async.AsyncRetry) – 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

Catalog level autocomplete config for customers to customize autocomplete feature’s settings.

Return type

google.cloud.retail_v2alpha.types.CompletionConfig

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

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 (Optional[Union[str,CatalogServiceTransport,Callable[..., CatalogServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the CatalogServiceTransport constructor. 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.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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

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!

add_catalog_attribute(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.AddCatalogAttributeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Adds the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned.

# 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 retail_v2alpha

def sample_add_catalog_attribute():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    catalog_attribute = retail_v2alpha.CatalogAttribute()
    catalog_attribute.key = "key_value"

    request = retail_v2alpha.AddCatalogAttributeRequest(
        attributes_config="attributes_config_value",
        catalog_attribute=catalog_attribute,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.AddCatalogAttributeRequest, dict]) – The request object. Request for [CatalogService.AddCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.AddCatalogAttribute] method.

• 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static attributes_config_path(project: str, location: str, catalog: str) → str

Returns a fully-qualified attributes_config string.

batch_remove_catalog_attributes(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog_service.BatchRemoveCatalogAttributesResponse

Removes all specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s from the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

# 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 retail_v2alpha

def sample_batch_remove_catalog_attributes():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.BatchRemoveCatalogAttributesRequest(
        attributes_config="attributes_config_value",
        attribute_keys=['attribute_keys_value1', 'attribute_keys_value2'],
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.BatchRemoveCatalogAttributesRequest, dict]) – The request object. Request for [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes] method.

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

[CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes].

Return type

google.cloud.retail_v2alpha.types.BatchRemoveCatalogAttributesResponse

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

Returns a fully-qualified branch string.

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.

static completion_config_path(project: str, location: str, catalog: str) → str

Returns a fully-qualified completion_config string.

classmethod from_service_account_file(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

classmethod from_service_account_info(info: dict, *args, **kwargs)

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_attributes_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.GetAttributesConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Gets an [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

# 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 retail_v2alpha

def sample_get_attributes_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetAttributesConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.GetAttributesConfigRequest, dict]) – The request object. Request for [CatalogService.GetAttributesConfig][google.cloud.retail.v2alpha.CatalogService.GetAttributesConfig] method.

• name (str) –

  Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

  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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

get_completion_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.GetCompletionConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.CompletionConfig

Gets a [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig].

# 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 retail_v2alpha

def sample_get_completion_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetCompletionConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.GetCompletionConfigRequest, dict]) – The request object. Request for [CatalogService.GetCompletionConfig][google.cloud.retail.v2alpha.CatalogService.GetCompletionConfig] method.

• name (str) –

  Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig

  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

Catalog level autocomplete config for customers to customize autocomplete feature’s settings.

Return type

google.cloud.retail_v2alpha.types.CompletionConfig

get_default_branch(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchRequest, dict]] = None, *, catalog: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog_service.GetDefaultBranchResponse

Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.SetDefaultBranch] method under a specified parent catalog.

# 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 retail_v2alpha

def sample_get_default_branch():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

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

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.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

Response message of

[CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch].

Return type

google.cloud.retail_v2alpha.types.GetDefaultBranchResponse

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)

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

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters

• request (GetOperationRequest) – The request object. Request message for GetOperation method.

• 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 Operation object.

Return type

Operation

list_catalogs(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsPager

Lists all the [Catalog][google.cloud.retail.v2alpha.Catalog]s associated with the project.

# 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 retail_v2alpha

def sample_list_catalogs():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

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

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

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

Parameters

• request (Union[google.cloud.retail_v2alpha.types.ListCatalogsRequest, dict]) – The request object. Request for [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] method.

• parent (str) –

  Required. The account resource name with an associated location.

  If the caller does not have permission to list [Catalog][google.cloud.retail.v2alpha.Catalog]s 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

Response for

[CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsPager

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters

• request (ListOperationsRequest) – The request object. Request message for ListOperations method.

• 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 ListOperations method.

Return type

ListOperationsResponse

static parse_attributes_config_path(path: str) → Dict[str, str]

Parses a attributes_config path into its component segments.

static parse_branch_path(path: str) → Dict[str, str]

Parses a branch path into its component segments.

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.

static parse_completion_config_path(path: str) → Dict[str, str]

Parses a completion_config path into its component segments.

remove_catalog_attribute(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.RemoveCatalogAttributeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Removes the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned.

# 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 retail_v2alpha

def sample_remove_catalog_attribute():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.RemoveCatalogAttributeRequest(
        attributes_config="attributes_config_value",
        key="key_value",
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.RemoveCatalogAttributeRequest, dict]) – The request object. Request for [CatalogService.RemoveCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.RemoveCatalogAttribute] method.

• 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

replace_catalog_attribute(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.ReplaceCatalogAttributeRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Replaces the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] in the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] by updating the catalog attribute with the same [CatalogAttribute.key][google.cloud.retail.v2alpha.CatalogAttribute.key].

If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to replace does not exist, a NOT_FOUND error is returned.

# 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 retail_v2alpha

def sample_replace_catalog_attribute():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    catalog_attribute = retail_v2alpha.CatalogAttribute()
    catalog_attribute.key = "key_value"

    request = retail_v2alpha.ReplaceCatalogAttributeRequest(
        attributes_config="attributes_config_value",
        catalog_attribute=catalog_attribute,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.ReplaceCatalogAttributeRequest, dict]) – The request object. Request for [CatalogService.ReplaceCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.ReplaceCatalogAttribute] method.

• 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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

set_default_branch(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.SetDefaultBranchRequest, dict]] = None, *, catalog: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Set a specified branch id as default branch. API methods such as [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search], [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct], [ProductService.ListProducts][google.cloud.retail.v2alpha.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 [SearchRequest.branch][google.cloud.retail.v2alpha.SearchRequest.branch] to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting [SearchRequest.branch][google.cloud.retail.v2alpha.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 [SearchRequest.branch][google.cloud.retail.v2alpha.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}.

# 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 retail_v2alpha

def sample_set_default_branch():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

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

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

Parameters

• request (Union[google.cloud.retail_v2alpha.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.

property transport: google.cloud.retail_v2alpha.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

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

update_attributes_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.UpdateAttributesConfigRequest, dict]] = None, *, attributes_config: Optional[google.cloud.retail_v2alpha.types.catalog.AttributesConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.AttributesConfig

Updates the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].

The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

# 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 retail_v2alpha

def sample_update_attributes_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    attributes_config = retail_v2alpha.AttributesConfig()
    attributes_config.name = "name_value"

    request = retail_v2alpha.UpdateAttributesConfigRequest(
        attributes_config=attributes_config,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.UpdateAttributesConfigRequest, dict]) – The request object. Request for [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2alpha.CatalogService.UpdateAttributesConfig] method.

• attributes_config (google.cloud.retail_v2alpha.types.AttributesConfig) –

  Required. The [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] to update.

  This corresponds to the attributes_config 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 [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] to update. The following is the only supported field:

  • [AttributesConfig.catalog_attributes][google.cloud.retail.v2alpha.AttributesConfig.catalog_attributes]

  If not set, all supported fields are updated.

  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

Catalog level attribute config.

Return type

google.cloud.retail_v2alpha.types.AttributesConfig

update_catalog(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.UpdateCatalogRequest, dict]] = None, *, catalog: Optional[google.cloud.retail_v2alpha.types.catalog.Catalog] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.Catalog

Updates the [Catalog][google.cloud.retail.v2alpha.Catalog]s.

# 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 retail_v2alpha

def sample_update_catalog():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

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

    request = retail_v2alpha.UpdateCatalogRequest(
        catalog=catalog,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.UpdateCatalogRequest, dict]) – The request object. Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2alpha.CatalogService.UpdateCatalog] method.

• catalog (google.cloud.retail_v2alpha.types.Catalog) –

  Required. The [Catalog][google.cloud.retail.v2alpha.Catalog] to update.

  If the caller does not have permission to update the [Catalog][google.cloud.retail.v2alpha.Catalog], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  If the [Catalog][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.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

The catalog configuration.

Return type

google.cloud.retail_v2alpha.types.Catalog

update_completion_config(request: Optional[Union[google.cloud.retail_v2alpha.types.catalog_service.UpdateCompletionConfigRequest, dict]] = None, *, completion_config: Optional[google.cloud.retail_v2alpha.types.catalog.CompletionConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.catalog.CompletionConfig

Updates the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig]s.

# 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 retail_v2alpha

def sample_update_completion_config():
    # Create a client
    client = retail_v2alpha.CatalogServiceClient()

    # Initialize request argument(s)
    completion_config = retail_v2alpha.CompletionConfig()
    completion_config.name = "name_value"

    request = retail_v2alpha.UpdateCompletionConfigRequest(
        completion_config=completion_config,
    )

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

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.retail_v2alpha.types.UpdateCompletionConfigRequest, dict]) – The request object. Request for [CatalogService.UpdateCompletionConfig][google.cloud.retail.v2alpha.CatalogService.UpdateCompletionConfig] method.

• completion_config (google.cloud.retail_v2alpha.types.CompletionConfig) –

  Required. The [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig] to update.

  If the caller does not have permission to update the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig], then a PERMISSION_DENIED error is returned.

  If the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig] to update does not exist, a NOT_FOUND error is returned.

  This corresponds to the completion_config 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 [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig] to update. The following are the only supported fields:

  • [CompletionConfig.matching_order][google.cloud.retail.v2alpha.CompletionConfig.matching_order]

  • [CompletionConfig.max_suggestions][google.cloud.retail.v2alpha.CompletionConfig.max_suggestions]

  • [CompletionConfig.min_prefix_length][google.cloud.retail.v2alpha.CompletionConfig.min_prefix_length]

  • [CompletionConfig.auto_learning][google.cloud.retail.v2alpha.CompletionConfig.auto_learning]

  If not set, all supported fields are updated.

  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

Catalog level autocomplete config for customers to customize autocomplete feature’s settings.

Return type

google.cloud.retail_v2alpha.types.CompletionConfig

class google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsAsyncPager(method: Callable[[...], Awaitable[google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse]], request: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest, response: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial google.cloud.retail_v2alpha.types.ListCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

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

All the usual google.cloud.retail_v2alpha.types.ListCatalogsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.retail_v2alpha.types.ListCatalogsRequest) – The initial request object.

• response (google.cloud.retail_v2alpha.types.ListCatalogsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.retail_v2alpha.services.catalog_service.pagers.ListCatalogsPager(method: Callable[[...], google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse], request: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsRequest, response: google.cloud.retail_v2alpha.types.catalog_service.ListCatalogsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial google.cloud.retail_v2alpha.types.ListCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

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

All the usual google.cloud.retail_v2alpha.types.ListCatalogsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.retail_v2alpha.types.ListCatalogsRequest) – The initial request object.

• response (google.cloud.retail_v2alpha.types.ListCatalogsResponse) – The initial response object.

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