Google Cloud Retail V2 Client - Class ServingConfigServiceClient (1.0.1)

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);
}

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
    );
}

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);
}

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);
}

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);
}

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);
}

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);
}