Google Cloud Retail V2 Client - Class CatalogServiceClient (1.3.1)

Version 1.3.1

• 1.6.4 (latest)
• 1.6.3
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Service Description: Service for managing catalog configuration.

This class is currently experimental and may be subject to changes.

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\BaseClient\self::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

getAttributesConfig

Gets an AttributesConfig.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::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

getCompletionConfig

Gets a CompletionConfig.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::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

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\BaseClient\self::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

listCatalogs

Lists all the Catalogs associated with the project.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::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

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\BaseClient\self::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

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\BaseClient\self::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

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\BaseClient\self::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.

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\BaseClient\self::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

updateCatalog

Updates the Catalogs.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::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

updateCompletionConfig

Updates the CompletionConfigs.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::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

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.