Google Cloud Retail V2 Client - Class ServingConfigServiceClient (1.0.1)

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

Service Description: Service for modifying ServingConfig.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$servingConfigServiceClient = new ServingConfigServiceClient();
try {
    $formattedServingConfig = $servingConfigServiceClient->servingConfigName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[SERVING_CONFIG]');
    $controlId = 'control_id';
    $response = $servingConfigServiceClient->addControl($formattedServingConfig, $controlId);
} finally {
    $servingConfigServiceClient->close();
}

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.

Methods

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.

servingConfigName

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

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

Returns
Type	Description
`string`	The formatted serving_config resource.

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

catalog: projects/{project}/locations/{location}/catalogs/{catalog}
servingConfig: projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}

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.

__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 {@see} object or {@see} 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 {@see} .
`↳ 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 {@see} 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 {@see} and {@see} 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.

addControl

Enables a Control on the specified ServingConfig.

The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Parameters
Name	Description
`servingConfig`	`string` Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
`controlId`	`string` Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\ServingConfig;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;

/**
 * @param string $formattedServingConfig The source ServingConfig resource name . Format:
 *                                       projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
 *                                       Please see {@see ServingConfigServiceClient::servingConfigName()} for help formatting this field.
 * @param string $controlId              The id of the control to apply. Assumed to be in the same catalog
 *                                       as the serving config - if id is not found a NOT_FOUND error is returned.
 */
function add_control_sample(string $formattedServingConfig, string $controlId): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

/**
 * 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
{
    $formattedServingConfig = ServingConfigServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[SERVING_CONFIG]'
    );
    $controlId = '[CONTROL_ID]';

    add_control_sample($formattedServingConfig, $controlId);
}

createServingConfig

Creates a ServingConfig.

A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

Parameters
Name	Description
`parent`	`string` Required. Full resource name of parent. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
`servingConfig`	`Google\Cloud\Retail\V2\ServingConfig` Required. The ServingConfig to create.
`servingConfigId`	`string` Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\ServingConfig;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;
use Google\Cloud\Retail\V2\SolutionType;

/**
 * @param string $formattedParent                   Full resource name of parent. Format:
 *                                                  `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
 *                                                  Please see {@see ServingConfigServiceClient::catalogName()} for help formatting this field.
 * @param string $servingConfigDisplayName          The human readable serving config display name. Used in Retail
 *                                                  UI.
 *
 *                                                  This field must be a UTF-8 encoded string with a length limit of 128
 *                                                  characters. Otherwise, an INVALID_ARGUMENT error is returned.
 * @param int    $servingConfigSolutionTypesElement Immutable. Specifies the solution types that a serving config can
 *                                                  be associated with. Currently we support setting only one type of solution.
 * @param string $servingConfigId                   The ID to use for the ServingConfig, which will become the final
 *                                                  component of the ServingConfig's resource name.
 *
 *                                                  This value should be 4-63 characters, and valid characters
 *                                                  are /[a-z][0-9]-_/.
 */
function create_serving_config_sample(
    string $formattedParent,
    string $servingConfigDisplayName,
    int $servingConfigSolutionTypesElement,
    string $servingConfigId
): void {
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $servingConfigSolutionTypes = [$servingConfigSolutionTypesElement,];
    $servingConfig = (new ServingConfig())
        ->setDisplayName($servingConfigDisplayName)
        ->setSolutionTypes($servingConfigSolutionTypes);

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

/**
 * 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 = ServingConfigServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $servingConfigDisplayName = '[DISPLAY_NAME]';
    $servingConfigSolutionTypesElement = SolutionType::SOLUTION_TYPE_UNSPECIFIED;
    $servingConfigId = '[SERVING_CONFIG_ID]';

    create_serving_config_sample(
        $formattedParent,
        $servingConfigDisplayName,
        $servingConfigSolutionTypesElement,
        $servingConfigId
    );
}

deleteServingConfig

Deletes a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name	Description
`name`	`string` Required. The resource name of the ServingConfig to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;

/**
 * @param string $formattedName The resource name of the ServingConfig to delete. Format:
 *                              projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
 *                              Please see {@see ServingConfigServiceClient::servingConfigName()} for help formatting this field.
 */
function delete_serving_config_sample(string $formattedName): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

/**
 * 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 = ServingConfigServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[SERVING_CONFIG]'
    );

    delete_serving_config_sample($formattedName);
}

getServingConfig

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name	Description
`name`	`string` Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\ServingConfig;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;

/**
 * @param string $formattedName The resource name of the ServingConfig to get. Format:
 *                              projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
 *                              Please see {@see ServingConfigServiceClient::servingConfigName()} for help formatting this field.
 */
function get_serving_config_sample(string $formattedName): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

/**
 * 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 = ServingConfigServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[SERVING_CONFIG]'
    );

    get_serving_config_sample($formattedName);
}

listServingConfigs

Lists all ServingConfigs linked to this catalog.

Parameters
Name	Description
`parent`	`string` Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Retail\V2\ServingConfig;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;

/**
 * @param string $formattedParent The catalog resource name. Format:
 *                                projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
 *                                Please see {@see ServingConfigServiceClient::catalogName()} for help formatting this field.
 */
function list_serving_configs_sample(string $formattedParent): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

        /** @var ServingConfig $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());
    }
}

/**
 * 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 = ServingConfigServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    list_serving_configs_sample($formattedParent);
}

removeControl

Disables a Control on the specified ServingConfig.

The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Parameters
Name	Description
`servingConfig`	`string` Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
`controlId`	`string` Required. The id of the control to apply. Assumed to be in the same catalog as the serving config.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\ServingConfig;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;

/**
 * @param string $formattedServingConfig The source ServingConfig resource name . Format:
 *                                       projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
 *                                       Please see {@see ServingConfigServiceClient::servingConfigName()} for help formatting this field.
 * @param string $controlId              The id of the control to apply. Assumed to be in the same catalog
 *                                       as the serving config.
 */
function remove_control_sample(string $formattedServingConfig, string $controlId): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

/**
 * 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
{
    $formattedServingConfig = ServingConfigServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[SERVING_CONFIG]'
    );
    $controlId = '[CONTROL_ID]';

    remove_control_sample($formattedServingConfig, $controlId);
}

updateServingConfig

Updates a ServingConfig.

Parameters
Name	Description
`servingConfig`	`Google\Cloud\Retail\V2\ServingConfig` Required. The ServingConfig to update.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\ServingConfig;
use Google\Cloud\Retail\V2\ServingConfigServiceClient;
use Google\Cloud\Retail\V2\SolutionType;

/**
 * @param string $servingConfigDisplayName          The human readable serving config display name. Used in Retail
 *                                                  UI.
 *
 *                                                  This field must be a UTF-8 encoded string with a length limit of 128
 *                                                  characters. Otherwise, an INVALID_ARGUMENT error is returned.
 * @param int    $servingConfigSolutionTypesElement Immutable. Specifies the solution types that a serving config can
 *                                                  be associated with. Currently we support setting only one type of solution.
 */
function update_serving_config_sample(
    string $servingConfigDisplayName,
    int $servingConfigSolutionTypesElement
): void {
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $servingConfigSolutionTypes = [$servingConfigSolutionTypesElement,];
    $servingConfig = (new ServingConfig())
        ->setDisplayName($servingConfigDisplayName)
        ->setSolutionTypes($servingConfigSolutionTypes);

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

/**
 * 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
{
    $servingConfigDisplayName = '[DISPLAY_NAME]';
    $servingConfigSolutionTypesElement = SolutionType::SOLUTION_TYPE_UNSPECIFIED;

    update_serving_config_sample($servingConfigDisplayName, $servingConfigSolutionTypesElement);
}

Constants

SERVICE_NAME

Value: 'google.cloud.retail.v2.ServingConfigService'

The name of the service.

SERVICE_ADDRESS

Value: 'retail.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.