Google Cloud Retail V2 Client - Class CatalogServiceClient (1.7.0)

Reference documentation and code samples for the Google Cloud Retail V2 Client class CatalogServiceClient.

Service Description: Service for managing catalog configuration.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ Retail \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

addCatalogAttribute

Adds the specified CatalogAttribute to the AttributesConfig.

If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::addCatalogAttributeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\AddCatalogAttributeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\AttributesConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AddCatalogAttributeRequest;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogAttribute;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;

/**
 * @param string $formattedAttributesConfig Full AttributesConfig resource name. Format:
 *                                          `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
 *                                          Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
 * @param string $catalogAttributeKey       Attribute name.
 *                                          For example: `color`, `brands`, `attributes.custom_attribute`, such as
 *                                          `attributes.xyz`.
 *                                          To be indexable, the attribute name can contain only alpha-numeric
 *                                          characters and underscores. For example, an attribute named
 *                                          `attributes.abc_xyz` can be indexed, but an attribute named
 *                                          `attributes.abc-xyz` cannot be indexed.
 *
 *                                          If the attribute key starts with `attributes.`, then the attribute is a
 *                                          custom attribute. Attributes such as `brands`, `patterns`, and `title` are
 *                                          built-in and called system attributes.
 */
function add_catalog_attribute_sample(
    string $formattedAttributesConfig,
    string $catalogAttributeKey
): void {
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $catalogAttribute = (new CatalogAttribute())
        ->setKey($catalogAttributeKey);
    $request = (new AddCatalogAttributeRequest())
        ->setAttributesConfig($formattedAttributesConfig)
        ->setCatalogAttribute($catalogAttribute);

    // Call the API and handle any network failures.
    try {
        /** @var AttributesConfig $response */
        $response = $catalogServiceClient->addCatalogAttribute($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedAttributesConfig = CatalogServiceClient::attributesConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]'
    );
    $catalogAttributeKey = '[KEY]';

    add_catalog_attribute_sample($formattedAttributesConfig, $catalogAttributeKey);
}

getAttributesConfig

Gets an AttributesConfig.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::getAttributesConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetAttributesConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\AttributesConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\GetAttributesConfigRequest;

/**
 * @param string $formattedName Full AttributesConfig resource name. Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
 *                              Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
 */
function get_attributes_config_sample(string $formattedName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new GetAttributesConfigRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var AttributesConfig $response */
        $response = $catalogServiceClient->getAttributesConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CatalogServiceClient::attributesConfigName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    get_attributes_config_sample($formattedName);
}

getCompletionConfig

Gets a CompletionConfig.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::getCompletionConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetCompletionConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\CompletionConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\CompletionConfig;
use Google\Cloud\Retail\V2\GetCompletionConfigRequest;

/**
 * @param string $formattedName Full CompletionConfig resource name. Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
 *                              Please see {@see CatalogServiceClient::completionConfigName()} for help formatting this field.
 */
function get_completion_config_sample(string $formattedName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new GetCompletionConfigRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var CompletionConfig $response */
        $response = $catalogServiceClient->getCompletionConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CatalogServiceClient::completionConfigName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    get_completion_config_sample($formattedName);
}

getDefaultBranch

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

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::getDefaultBranchAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetDefaultBranchRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\GetDefaultBranchResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\GetDefaultBranchRequest;
use Google\Cloud\Retail\V2\GetDefaultBranchResponse;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_default_branch_sample(): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = new GetDefaultBranchRequest();

    // Call the API and handle any network failures.
    try {
        /** @var GetDefaultBranchResponse $response */
        $response = $catalogServiceClient->getDefaultBranch($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listCatalogs

Lists all the Catalogs associated with the project.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::listCatalogsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ListCatalogsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Retail\V2\Catalog;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\ListCatalogsRequest;

/**
 * @param string $formattedParent The account resource name with an associated location.
 *
 *                                If the caller does not have permission to list
 *                                [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless
 *                                of whether or not this location exists, a PERMISSION_DENIED error is
 *                                returned. Please see
 *                                {@see CatalogServiceClient::locationName()} for help formatting this field.
 */
function list_catalogs_sample(string $formattedParent): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new ListCatalogsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $catalogServiceClient->listCatalogs($request);

        /** @var Catalog $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CatalogServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_catalogs_sample($formattedParent);
}

removeCatalogAttribute

Removes the specified CatalogAttribute from the AttributesConfig.

If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::removeCatalogAttributeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\RemoveCatalogAttributeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\AttributesConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\RemoveCatalogAttributeRequest;

/**
 * @param string $formattedAttributesConfig Full AttributesConfig resource name. Format:
 *                                          `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
 *                                          Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
 * @param string $key                       The attribute name key of the
 *                                          [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to remove.
 */
function remove_catalog_attribute_sample(string $formattedAttributesConfig, string $key): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new RemoveCatalogAttributeRequest())
        ->setAttributesConfig($formattedAttributesConfig)
        ->setKey($key);

    // Call the API and handle any network failures.
    try {
        /** @var AttributesConfig $response */
        $response = $catalogServiceClient->removeCatalogAttribute($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedAttributesConfig = CatalogServiceClient::attributesConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]'
    );
    $key = '[KEY]';

    remove_catalog_attribute_sample($formattedAttributesConfig, $key);
}

replaceCatalogAttribute

Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.

If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::replaceCatalogAttributeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ReplaceCatalogAttributeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\AttributesConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogAttribute;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\ReplaceCatalogAttributeRequest;

/**
 * @param string $formattedAttributesConfig Full AttributesConfig resource name. Format:
 *                                          `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
 *                                          Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
 * @param string $catalogAttributeKey       Attribute name.
 *                                          For example: `color`, `brands`, `attributes.custom_attribute`, such as
 *                                          `attributes.xyz`.
 *                                          To be indexable, the attribute name can contain only alpha-numeric
 *                                          characters and underscores. For example, an attribute named
 *                                          `attributes.abc_xyz` can be indexed, but an attribute named
 *                                          `attributes.abc-xyz` cannot be indexed.
 *
 *                                          If the attribute key starts with `attributes.`, then the attribute is a
 *                                          custom attribute. Attributes such as `brands`, `patterns`, and `title` are
 *                                          built-in and called system attributes.
 */
function replace_catalog_attribute_sample(
    string $formattedAttributesConfig,
    string $catalogAttributeKey
): void {
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $catalogAttribute = (new CatalogAttribute())
        ->setKey($catalogAttributeKey);
    $request = (new ReplaceCatalogAttributeRequest())
        ->setAttributesConfig($formattedAttributesConfig)
        ->setCatalogAttribute($catalogAttribute);

    // Call the API and handle any network failures.
    try {
        /** @var AttributesConfig $response */
        $response = $catalogServiceClient->replaceCatalogAttribute($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedAttributesConfig = CatalogServiceClient::attributesConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]'
    );
    $catalogAttributeKey = '[KEY]';

    replace_catalog_attribute_sample($formattedAttributesConfig, $catalogAttributeKey);
}

setDefaultBranch

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

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::setDefaultBranchAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\SetDefaultBranchRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\SetDefaultBranchRequest;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function set_default_branch_sample(): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = new SetDefaultBranchRequest();

    // Call the API and handle any network failures.
    try {
        $catalogServiceClient->setDefaultBranch($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateAttributesConfig

Updates the 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.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::updateAttributesConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateAttributesConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\AttributesConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\UpdateAttributesConfigRequest;

/**
 * @param string $attributesConfigName Immutable. The fully qualified resource name of the attribute
 *                                     config. Format: `projects/&#42;/locations/&#42;/catalogs/&#42;/attributesConfig`
 */
function update_attributes_config_sample(string $attributesConfigName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $attributesConfig = (new AttributesConfig())
        ->setName($attributesConfigName);
    $request = (new UpdateAttributesConfigRequest())
        ->setAttributesConfig($attributesConfig);

    // Call the API and handle any network failures.
    try {
        /** @var AttributesConfig $response */
        $response = $catalogServiceClient->updateAttributesConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $attributesConfigName = '[NAME]';

    update_attributes_config_sample($attributesConfigName);
}

updateCatalog

Updates the Catalogs.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::updateCatalogAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateCatalogRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\Catalog`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Catalog;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\ProductLevelConfig;
use Google\Cloud\Retail\V2\UpdateCatalogRequest;

/**
 * @param string $catalogName        Immutable. The fully qualified resource name of the catalog.
 * @param string $catalogDisplayName Immutable. The catalog display name.
 *
 *                                   This field must be a UTF-8 encoded string with a length limit of 128
 *                                   characters. Otherwise, an INVALID_ARGUMENT error is returned.
 */
function update_catalog_sample(string $catalogName, string $catalogDisplayName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $catalogProductLevelConfig = new ProductLevelConfig();
    $catalog = (new Catalog())
        ->setName($catalogName)
        ->setDisplayName($catalogDisplayName)
        ->setProductLevelConfig($catalogProductLevelConfig);
    $request = (new UpdateCatalogRequest())
        ->setCatalog($catalog);

    // Call the API and handle any network failures.
    try {
        /** @var Catalog $response */
        $response = $catalogServiceClient->updateCatalog($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $catalogName = '[NAME]';
    $catalogDisplayName = '[DISPLAY_NAME]';

    update_catalog_sample($catalogName, $catalogDisplayName);
}

updateCompletionConfig

Updates the CompletionConfigs.

The async variant is Google\Cloud\Retail\V2\Client\CatalogServiceClient::updateCompletionConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateCompletionConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Retail\V2\CompletionConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Client\CatalogServiceClient;
use Google\Cloud\Retail\V2\CompletionConfig;
use Google\Cloud\Retail\V2\UpdateCompletionConfigRequest;

/**
 * @param string $completionConfigName Immutable. Fully qualified name
 *                                     `projects/&#42;/locations/&#42;/catalogs/&#42;/completionConfig`
 */
function update_completion_config_sample(string $completionConfigName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $completionConfig = (new CompletionConfig())
        ->setName($completionConfigName);
    $request = (new UpdateCompletionConfigRequest())
        ->setCompletionConfig($completionConfig);

    // Call the API and handle any network failures.
    try {
        /** @var CompletionConfig $response */
        $response = $catalogServiceClient->updateCompletionConfig($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $completionConfigName = '[NAME]';

    update_completion_config_sample($completionConfigName);
}

addCatalogAttributeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\AddCatalogAttributeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAttributesConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetAttributesConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getCompletionConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetCompletionConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDefaultBranchAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetDefaultBranchRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listCatalogsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ListCatalogsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

removeCatalogAttributeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\RemoveCatalogAttributeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

replaceCatalogAttributeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ReplaceCatalogAttributeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setDefaultBranchAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\SetDefaultBranchRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAttributesConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateAttributesConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateCatalogAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateCatalogRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateCompletionConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateCompletionConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::attributesConfigName

Formats a string containing the fully-qualified path to represent a attributes_config resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`

Returns
Type	Description
`string`	The formatted attributes_config resource.

static::branchName

Formats a string containing the fully-qualified path to represent a branch resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`
`branch`	`string`

Returns
Type	Description
`string`	The formatted branch resource.

static::catalogName

Formats a string containing the fully-qualified path to represent a catalog resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`

Returns
Type	Description
`string`	The formatted catalog resource.

static::completionConfigName

Formats a string containing the fully-qualified path to represent a completion_config resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`

Returns
Type	Description
`string`	The formatted completion_config resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

attributesConfig: projects/{project}/locations/{location}/catalogs/{catalog}/attributesConfig
branch: projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}
catalog: projects/{project}/locations/{location}/catalogs/{catalog}
completionConfig: projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig
location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.