Google Cloud Retail V2 Client - Class ControlServiceClient (1.2.1)

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

Service Description: Service for modifying Control.

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:

$controlServiceClient = new ControlServiceClient();
try {
    $formattedParent = $controlServiceClient->catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $control = new Control();
    $controlId = 'control_id';
    $response = $controlServiceClient->createControl($formattedParent, $control, $controlId);
} finally {
    $controlServiceClient->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
NameDescription
project string
location string
catalog string
Returns
TypeDescription
stringThe formatted catalog resource.

controlName

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

Parameters
NameDescription
project string
location string
catalog string
control string
Returns
TypeDescription
stringThe formatted control 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}
  • control: projects/{project}/locations/{location}/catalogs/{catalog}/controls/{control}

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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

__construct

Constructor.

Parameters
NameDescription
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.

createControl

Creates a Control.

If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters
NameDescription
parent string

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

control Google\Cloud\Retail\V2\Control

Required. The Control to create.

controlId string

Required. The ID to use for the Control, which will become the final component of the Control'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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Retail\V2\Control
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Control;
use Google\Cloud\Retail\V2\ControlServiceClient;
use Google\Cloud\Retail\V2\SolutionType;

/**
 * @param string $formattedParent             Full resource name of parent catalog. Format:
 *                                            `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
 *                                            Please see {@see ControlServiceClient::catalogName()} for help formatting this field.
 * @param string $controlDisplayName          The human readable control 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 thrown.
 * @param int    $controlSolutionTypesElement Immutable. The solution types that the control is used for.
 *                                            Currently we support setting only one type of solution at creation time.
 *
 *                                            Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 *                                            If no solution type is provided at creation time, will default to
 *                                            [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
 * @param string $controlId                   The ID to use for the Control, which will become the final
 *                                            component of the Control's resource name.
 *
 *                                            This value should be 4-63 characters, and valid characters
 *                                            are /[a-z][0-9]-_/.
 */
function create_control_sample(
    string $formattedParent,
    string $controlDisplayName,
    int $controlSolutionTypesElement,
    string $controlId
): void {
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $controlSolutionTypes = [$controlSolutionTypesElement,];
    $control = (new Control())
        ->setDisplayName($controlDisplayName)
        ->setSolutionTypes($controlSolutionTypes);

    // Call the API and handle any network failures.
    try {
        /** @var Control $response */
        $response = $controlServiceClient->createControl($formattedParent, $control, $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
{
    $formattedParent = ControlServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $controlDisplayName = '[DISPLAY_NAME]';
    $controlSolutionTypesElement = SolutionType::SOLUTION_TYPE_UNSPECIFIED;
    $controlId = '[CONTROL_ID]';

    create_control_sample(
        $formattedParent,
        $controlDisplayName,
        $controlSolutionTypesElement,
        $controlId
    );
}

deleteControl

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters
NameDescription
name string

Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

optionalArgs 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\ControlServiceClient;

/**
 * @param string $formattedName The resource name of the Control to delete. Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
 *                              Please see {@see ControlServiceClient::controlName()} for help formatting this field.
 */
function delete_control_sample(string $formattedName): void
{
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

    // Call the API and handle any network failures.
    try {
        $controlServiceClient->deleteControl($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 = ControlServiceClient::controlName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[CONTROL]'
    );

    delete_control_sample($formattedName);
}

getControl

Gets a Control.

Parameters
NameDescription
name string

Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

optionalArgs 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
TypeDescription
Google\Cloud\Retail\V2\Control
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Control;
use Google\Cloud\Retail\V2\ControlServiceClient;

/**
 * @param string $formattedName The resource name of the Control to get. Format:
 *                              `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
 *                              Please see {@see ControlServiceClient::controlName()} for help formatting this field.
 */
function get_control_sample(string $formattedName): void
{
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Control $response */
        $response = $controlServiceClient->getControl($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 = ControlServiceClient::controlName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[CONTROL]'
    );

    get_control_sample($formattedName);
}

listControls

Lists all Controls by their parent Catalog.

Parameters
NameDescription
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.

↳ filter string

Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Retail\V2\Control;
use Google\Cloud\Retail\V2\ControlServiceClient;

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

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

        /** @var Control $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 = ControlServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    list_controls_sample($formattedParent);
}

updateControl

Updates a Control.

Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.

Parameters
NameDescription
control Google\Cloud\Retail\V2\Control

Required. The Control to update.

optionalArgs array

Optional.

↳ updateMask FieldMask

Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name If not set or empty, all supported fields are updated.

↳ 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
TypeDescription
Google\Cloud\Retail\V2\Control
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Control;
use Google\Cloud\Retail\V2\ControlServiceClient;
use Google\Cloud\Retail\V2\SolutionType;

/**
 * @param string $controlDisplayName          The human readable control 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 thrown.
 * @param int    $controlSolutionTypesElement Immutable. The solution types that the control is used for.
 *                                            Currently we support setting only one type of solution at creation time.
 *
 *                                            Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 *                                            If no solution type is provided at creation time, will default to
 *                                            [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
 */
function update_control_sample(string $controlDisplayName, int $controlSolutionTypesElement): void
{
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $controlSolutionTypes = [$controlSolutionTypesElement,];
    $control = (new Control())
        ->setDisplayName($controlDisplayName)
        ->setSolutionTypes($controlSolutionTypes);

    // Call the API and handle any network failures.
    try {
        /** @var Control $response */
        $response = $controlServiceClient->updateControl($control);
        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
{
    $controlDisplayName = '[DISPLAY_NAME]';
    $controlSolutionTypesElement = SolutionType::SOLUTION_TYPE_UNSPECIFIED;

    update_control_sample($controlDisplayName, $controlSolutionTypesElement);
}

Constants

SERVICE_NAME

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

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.