Google Cloud Discovery Engine V1 Client - Class DataStoreServiceClient (1.3.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\DataStoreServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CreateDataStoreRequest;
use Google\Cloud\DiscoveryEngine\V1\DataStore;
use Google\Rpc\Status;

/**
 * @param string $formattedParent      The parent resource name, such as
 *                                     `projects/{project}/locations/{location}/collections/{collection}`. Please see
 *                                     {@see DataStoreServiceClient::collectionName()} for help formatting this field.
 * @param string $dataStoreDisplayName The data store display name.
 *
 *                                     This field must be a UTF-8 encoded string with a length limit of 128
 *                                     characters. Otherwise, an INVALID_ARGUMENT error is returned.
 * @param string $dataStoreId          The ID to use for the
 *                                     [DataStore][google.cloud.discoveryengine.v1.DataStore], which will become
 *                                     the final component of the
 *                                     [DataStore][google.cloud.discoveryengine.v1.DataStore]'s resource name.
 *
 *                                     This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 *                                     standard with a length limit of 63 characters. Otherwise, an
 *                                     INVALID_ARGUMENT error is returned.
 */
function create_data_store_sample(
    string $formattedParent,
    string $dataStoreDisplayName,
    string $dataStoreId
): void {
    // Create a client.
    $dataStoreServiceClient = new DataStoreServiceClient();

    // Prepare the request message.
    $dataStore = (new DataStore())
        ->setDisplayName($dataStoreDisplayName);
    $request = (new CreateDataStoreRequest())
        ->setParent($formattedParent)
        ->setDataStore($dataStore)
        ->setDataStoreId($dataStoreId);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $dataStoreServiceClient->createDataStore($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var DataStore $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = DataStoreServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );
    $dataStoreDisplayName = '[DISPLAY_NAME]';
    $dataStoreId = '[DATA_STORE_ID]';

    create_data_store_sample($formattedParent, $dataStoreDisplayName, $dataStoreId);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\DataStoreServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteDataStoreRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Full resource name of
 *                              [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
 *                              `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 *
 *                              If the caller does not have permission to delete the
 *                              [DataStore][google.cloud.discoveryengine.v1.DataStore], regardless of
 *                              whether or not it exists, a PERMISSION_DENIED error is returned.
 *
 *                              If the [DataStore][google.cloud.discoveryengine.v1.DataStore] to delete
 *                              does not exist, a NOT_FOUND error is returned. Please see
 *                              {@see DataStoreServiceClient::dataStoreName()} for help formatting this field.
 */
function delete_data_store_sample(string $formattedName): void
{
    // Create a client.
    $dataStoreServiceClient = new DataStoreServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $dataStoreServiceClient->deleteDataStore($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = DataStoreServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');

    delete_data_store_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\DataStoreServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DataStore;
use Google\Cloud\DiscoveryEngine\V1\GetDataStoreRequest;

/**
 * @param string $formattedName Full resource name of
 *                              [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
 *                              `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 *
 *                              If the caller does not have permission to access the
 *                              [DataStore][google.cloud.discoveryengine.v1.DataStore], regardless of
 *                              whether or not it exists, a PERMISSION_DENIED error is returned.
 *
 *                              If the requested [DataStore][google.cloud.discoveryengine.v1.DataStore]
 *                              does not exist, a NOT_FOUND error is returned. Please see
 *                              {@see DataStoreServiceClient::dataStoreName()} for help formatting this field.
 */
function get_data_store_sample(string $formattedName): void
{
    // Create a client.
    $dataStoreServiceClient = new DataStoreServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataStore $response */
        $response = $dataStoreServiceClient->getDataStore($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 = DataStoreServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');

    get_data_store_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\DataStoreServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DataStore;
use Google\Cloud\DiscoveryEngine\V1\ListDataStoresRequest;

/**
 * @param string $formattedParent The parent branch resource name, such as
 *                                `projects/{project}/locations/{location}/collections/{collection_id}`.
 *
 *                                If the caller does not have permission to list
 *                                [DataStore][google.cloud.discoveryengine.v1.DataStore]s under this
 *                                location, regardless of whether or not this data store exists, a
 *                                PERMISSION_DENIED error is returned. Please see
 *                                {@see DataStoreServiceClient::collectionName()} for help formatting this field.
 */
function list_data_stores_sample(string $formattedParent): void
{
    // Create a client.
    $dataStoreServiceClient = new DataStoreServiceClient();

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

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

        /** @var DataStore $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 = DataStoreServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );

    list_data_stores_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\DataStoreServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DataStore;
use Google\Cloud\DiscoveryEngine\V1\UpdateDataStoreRequest;

/**
 * @param string $dataStoreDisplayName The data store display name.
 *
 *                                     This field must be a UTF-8 encoded string with a length limit of 128
 *                                     characters. Otherwise, an INVALID_ARGUMENT error is returned.
 */
function update_data_store_sample(string $dataStoreDisplayName): void
{
    // Create a client.
    $dataStoreServiceClient = new DataStoreServiceClient();

    // Prepare the request message.
    $dataStore = (new DataStore())
        ->setDisplayName($dataStoreDisplayName);
    $request = (new UpdateDataStoreRequest())
        ->setDataStore($dataStore);

    // Call the API and handle any network failures.
    try {
        /** @var DataStore $response */
        $response = $dataStoreServiceClient->updateDataStore($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
{
    $dataStoreDisplayName = '[DISPLAY_NAME]';

    update_data_store_sample($dataStoreDisplayName);
}