Google Cloud Discovery Engine V1 Client - Class ControlServiceClient (1.3.3)

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\ControlServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Control;
use Google\Cloud\DiscoveryEngine\V1\CreateControlRequest;
use Google\Cloud\DiscoveryEngine\V1\SolutionType;

/**
 * @param string $formattedParent     Full resource name of parent data store. Format:
 *                                    `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
 *                                    or
 *                                    `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Please see
 *                                    {@see ControlServiceClient::dataStoreName()} for help formatting this field.
 * @param string $controlDisplayName  Human readable name. The identifier used in UI views.
 *
 *                                    Must be UTF-8 encoded string. Length limit is 128 characters.
 *                                    Otherwise an INVALID ARGUMENT error is thrown.
 * @param int    $controlSolutionType Immutable. What solution the control belongs to.
 *
 *                                    Must be compatible with vertical of resource.
 *                                    Otherwise an INVALID ARGUMENT error is thrown.
 * @param string $controlId           The ID to use for the Control, which will become the final
 *                                    component of the Control's resource name.
 *
 *                                    This value must be within 1-63 characters.
 *                                    Valid characters are /[a-z][0-9]-_/.
 */
function create_control_sample(
    string $formattedParent,
    string $controlDisplayName,
    int $controlSolutionType,
    string $controlId
): void {
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

    // Prepare the request message.
    $control = (new Control())
        ->setDisplayName($controlDisplayName)
        ->setSolutionType($controlSolutionType);
    $request = (new CreateControlRequest())
        ->setParent($formattedParent)
        ->setControl($control)
        ->setControlId($controlId);

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\ControlServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteControlRequest;

/**
 * @param string $formattedName The resource name of the Control to delete. Format:
 *                              `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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();

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

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

    delete_control_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\ControlServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Control;
use Google\Cloud\DiscoveryEngine\V1\GetControlRequest;

/**
 * @param string $formattedName The resource name of the Control to get. Format:
 *                              `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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();

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

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

    get_control_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\ControlServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Control;
use Google\Cloud\DiscoveryEngine\V1\ListControlsRequest;

/**
 * @param string $formattedParent The data store resource name. Format:
 *                                `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
 *                                or
 *                                `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Please see
 *                                {@see ControlServiceClient::dataStoreName()} for help formatting this field.
 */
function list_controls_sample(string $formattedParent): void
{
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

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

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

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

/**
 * 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 = ControlServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');

    list_controls_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\ControlServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Control;
use Google\Cloud\DiscoveryEngine\V1\SolutionType;
use Google\Cloud\DiscoveryEngine\V1\UpdateControlRequest;

/**
 * @param string $controlDisplayName  Human readable name. The identifier used in UI views.
 *
 *                                    Must be UTF-8 encoded string. Length limit is 128 characters.
 *                                    Otherwise an INVALID ARGUMENT error is thrown.
 * @param int    $controlSolutionType Immutable. What solution the control belongs to.
 *
 *                                    Must be compatible with vertical of resource.
 *                                    Otherwise an INVALID ARGUMENT error is thrown.
 */
function update_control_sample(string $controlDisplayName, int $controlSolutionType): void
{
    // Create a client.
    $controlServiceClient = new ControlServiceClient();

    // Prepare the request message.
    $control = (new Control())
        ->setDisplayName($controlDisplayName)
        ->setSolutionType($controlSolutionType);
    $request = (new UpdateControlRequest())
        ->setControl($control);

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

    update_control_sample($controlDisplayName, $controlSolutionType);
}