Google Cloud Discovery Engine V1 Client - Class EngineServiceClient (1.0.0)

Namespace

Methods

__construct

createEngine

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CreateEngineRequest;
use Google\Cloud\DiscoveryEngine\V1\Engine;
use Google\Cloud\DiscoveryEngine\V1\SolutionType;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    The parent resource name, such as
 *                                   `projects/{project}/locations/{location}/collections/{collection}`. Please see
 *                                   {@see EngineServiceClient::collectionName()} for help formatting this field.
 * @param string $engineDisplayName  The display name of the engine. Should be human readable. UTF-8
 *                                   encoded string with limit of 1024 characters.
 * @param int    $engineSolutionType The solutions of the engine.
 * @param string $engineId           The ID to use for the
 *                                   [Engine][google.cloud.discoveryengine.v1.Engine], which will become the
 *                                   final component of the [Engine][google.cloud.discoveryengine.v1.Engine]'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_engine_sample(
    string $formattedParent,
    string $engineDisplayName,
    int $engineSolutionType,
    string $engineId
): void {
    // Create a client.
    $engineServiceClient = new EngineServiceClient();

    // Prepare the request message.
    $engine = (new Engine())
        ->setDisplayName($engineDisplayName)
        ->setSolutionType($engineSolutionType);
    $request = (new CreateEngineRequest())
        ->setParent($formattedParent)
        ->setEngine($engine)
        ->setEngineId($engineId);

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

        if ($response->operationSucceeded()) {
            /** @var Engine $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 = EngineServiceClient::collectionName('[PROJECT]', '[LOCATION]', '[COLLECTION]');
    $engineDisplayName = '[DISPLAY_NAME]';
    $engineSolutionType = SolutionType::SOLUTION_TYPE_UNSPECIFIED;
    $engineId = '[ENGINE_ID]';

    create_engine_sample($formattedParent, $engineDisplayName, $engineSolutionType, $engineId);
}

deleteEngine

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteEngineRequest;
use Google\Rpc\Status;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $engineServiceClient->deleteEngine($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 = EngineServiceClient::engineName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]'
    );

    delete_engine_sample($formattedName);
}

getEngine

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Engine;
use Google\Cloud\DiscoveryEngine\V1\GetEngineRequest;

/**
 * @param string $formattedName Full resource name of
 *                              [Engine][google.cloud.discoveryengine.v1.Engine], such as
 *                              `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Please see
 *                              {@see EngineServiceClient::engineName()} for help formatting this field.
 */
function get_engine_sample(string $formattedName): void
{
    // Create a client.
    $engineServiceClient = new EngineServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Engine $response */
        $response = $engineServiceClient->getEngine($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 = EngineServiceClient::engineName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]'
    );

    get_engine_sample($formattedName);
}

listEngines

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Engine;
use Google\Cloud\DiscoveryEngine\V1\ListEnginesRequest;

/**
 * @param string $formattedParent The parent resource name, such as
 *                                `projects/{project}/locations/{location}/collections/{collection_id}`. Please see
 *                                {@see EngineServiceClient::collectionName()} for help formatting this field.
 */
function list_engines_sample(string $formattedParent): void
{
    // Create a client.
    $engineServiceClient = new EngineServiceClient();

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

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

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

    list_engines_sample($formattedParent);
}

updateEngine

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Engine;
use Google\Cloud\DiscoveryEngine\V1\SolutionType;
use Google\Cloud\DiscoveryEngine\V1\UpdateEngineRequest;

/**
 * @param string $engineDisplayName  The display name of the engine. Should be human readable. UTF-8
 *                                   encoded string with limit of 1024 characters.
 * @param int    $engineSolutionType The solutions of the engine.
 */
function update_engine_sample(string $engineDisplayName, int $engineSolutionType): void
{
    // Create a client.
    $engineServiceClient = new EngineServiceClient();

    // Prepare the request message.
    $engine = (new Engine())
        ->setDisplayName($engineDisplayName)
        ->setSolutionType($engineSolutionType);
    $request = (new UpdateEngineRequest())
        ->setEngine($engine);

    // Call the API and handle any network failures.
    try {
        /** @var Engine $response */
        $response = $engineServiceClient->updateEngine($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
{
    $engineDisplayName = '[DISPLAY_NAME]';
    $engineSolutionType = SolutionType::SOLUTION_TYPE_UNSPECIFIED;

    update_engine_sample($engineDisplayName, $engineSolutionType);
}

createEngineAsync

deleteEngineAsync

getEngineAsync

listEnginesAsync

updateEngineAsync

getOperationsClient

resumeOperation

static::collectionName

static::engineName

static::parseName