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

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class EngineServiceClient.

Service Description: Service for managing Engine configuration.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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.

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`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.

createEngine

Creates a Engine.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient::createEngineAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\CreateEngineRequest` A request to house fields associated with the call.
`callOptions`	`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
Type	Description
`Google\ApiCore\OperationResponse`

Example

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

Deletes a Engine.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient::deleteEngineAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\DeleteEngineRequest` A request to house fields associated with the call.
`callOptions`	`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
Type	Description
`Google\ApiCore\OperationResponse`

Example

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

Gets a Engine.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient::getEngineAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\GetEngineRequest` A request to house fields associated with the call.
`callOptions`	`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
Type	Description
`Google\Cloud\DiscoveryEngine\V1\Engine`

Example

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

Lists all the Engines associated with the project.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient::listEnginesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\ListEnginesRequest` A request to house fields associated with the call.
`callOptions`	`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
Type	Description
`Google\ApiCore\PagedListResponse`

Example

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

Updates an Engine

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\EngineServiceClient::updateEngineAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\UpdateEngineRequest` A request to house fields associated with the call.
`callOptions`	`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
Type	Description
`Google\Cloud\DiscoveryEngine\V1\Engine`

Example

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

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\CreateEngineRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteEngineAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\DeleteEngineRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getEngineAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\GetEngineRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listEnginesAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\ListEnginesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateEngineAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\UpdateEngineRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\LongRunning\Client\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::collectionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`

Returns
Type	Description
`string`	The formatted collection resource.

static::engineName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`

Returns
Type	Description
`string`	The formatted engine resource.

static::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

collection: projects/{project}/locations/{location}/collections/{collection}
engine: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

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
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.