Google Cloud Discovery Engine V1 Client - Class SchemaServiceClient (0.6.0)

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

Service Description: Service for managing Schemas.

This class is currently experimental and may be subject to changes.

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.

createSchema

Creates a Schema.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\BaseClient\self::createSchemaAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\CreateSchemaRequest` 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\SchemaServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CreateSchemaRequest;
use Google\Cloud\DiscoveryEngine\V1\Schema;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent data store resource name, in the format of
 *                                `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Please see
 *                                {@see SchemaServiceClient::dataStoreName()} for help formatting this field.
 * @param string $schemaId        The ID to use for the
 *                                [Schema][google.cloud.discoveryengine.v1.Schema], which will become the
 *                                final component of the
 *                                [Schema.name][google.cloud.discoveryengine.v1.Schema.name].
 *
 *                                This field should conform to
 *                                [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
 *                                limit of 63 characters.
 */
function create_schema_sample(string $formattedParent, string $schemaId): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare the request message.
    $schema = new Schema();
    $request = (new CreateSchemaRequest())
        ->setParent($formattedParent)
        ->setSchema($schema)
        ->setSchemaId($schemaId);

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

        if ($response->operationSucceeded()) {
            /** @var Schema $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 = SchemaServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');
    $schemaId = '[SCHEMA_ID]';

    create_schema_sample($formattedParent, $schemaId);
}

deleteSchema

Deletes a Schema.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\BaseClient\self::deleteSchemaAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\DeleteSchemaRequest` 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\SchemaServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteSchemaRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The full resource name of the schema, in the format of
 *                              `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 */
function delete_schema_sample(string $formattedName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $schemaServiceClient->deleteSchema($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 = SchemaServiceClient::schemaName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[SCHEMA]'
    );

    delete_schema_sample($formattedName);
}

getSchema

Gets a Schema.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\BaseClient\self::getSchemaAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\GetSchemaRequest` 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\Schema`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\SchemaServiceClient;
use Google\Cloud\DiscoveryEngine\V1\GetSchemaRequest;
use Google\Cloud\DiscoveryEngine\V1\Schema;

/**
 * @param string $formattedName The full resource name of the schema, in the format of
 *                              `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 */
function get_schema_sample(string $formattedName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Schema $response */
        $response = $schemaServiceClient->getSchema($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 = SchemaServiceClient::schemaName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[SCHEMA]'
    );

    get_schema_sample($formattedName);
}

listSchemas

Gets a list of Schemas.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\BaseClient\self::listSchemasAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\ListSchemasRequest` 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\SchemaServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ListSchemasRequest;
use Google\Cloud\DiscoveryEngine\V1\Schema;

/**
 * @param string $formattedParent The parent data store resource name, in the format of
 *                                `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Please see
 *                                {@see SchemaServiceClient::dataStoreName()} for help formatting this field.
 */
function list_schemas_sample(string $formattedParent): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

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

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

        /** @var Schema $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 = SchemaServiceClient::dataStoreName('[PROJECT]', '[LOCATION]', '[DATA_STORE]');

    list_schemas_sample($formattedParent);
}

updateSchema

Updates a Schema.

The async variant is Google\Cloud\DiscoveryEngine\V1\Client\BaseClient\self::updateSchemaAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1\UpdateSchemaRequest` 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\SchemaServiceClient;
use Google\Cloud\DiscoveryEngine\V1\Schema;
use Google\Cloud\DiscoveryEngine\V1\UpdateSchemaRequest;
use Google\Rpc\Status;

/**
 * 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 update_schema_sample(): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare the request message.
    $schema = new Schema();
    $request = (new UpdateSchemaRequest())
        ->setSchema($schema);

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

        if ($response->operationSucceeded()) {
            /** @var Schema $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());
    }
}

createSchemaAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSchemaAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSchemaAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSchemasAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateSchemaAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

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

Returns
Type	Description
`Google\ApiCore\LongRunning\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::dataStoreName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	The formatted data_store resource.

static::projectLocationCollectionDataStoreName

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

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

Returns
Type	Description
`string`	The formatted project_location_collection_data_store resource.

static::projectLocationCollectionDataStoreSchemaName

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

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

Returns
Type	Description
`string`	The formatted project_location_collection_data_store_schema resource.

static::projectLocationDataStoreName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store resource.

static::projectLocationDataStoreSchemaName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`schema`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store_schema resource.

static::schemaName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`schema`	`string`

Returns
Type	Description
`string`	The formatted schema 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

dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
projectLocationCollectionDataStoreSchema: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}
projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
projectLocationDataStoreSchema: projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}
schema: projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}

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.