Google Cloud Vector Search V1 Client - Class DataObjectServiceClient (0.2.0)

Reference documentation and code samples for the Google Cloud Vector Search V1 Client class DataObjectServiceClient.

Service Description: Service for creating and managing data objects.

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 \ VectorSearch \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array\|Google\ApiCore\Options\ClientOptions` 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`	`FetchAuthTokenInterface\|CredentialsWrapper` This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\VectorSearch\V1\DataObjectServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new DataObjectServiceClient(['credentials' => $creds]);` https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
`↳ 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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
`↳ universeDomain`	`string` The service domain for the client. Defaults to 'googleapis.com'.

batchCreateDataObjects

Creates a batch of dataObjects.

The async variant is DataObjectServiceClient::batchCreateDataObjectsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\BatchCreateDataObjectsRequest` 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\VectorSearch\V1\BatchCreateDataObjectsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\BatchCreateDataObjectsRequest;
use Google\Cloud\VectorSearch\V1\BatchCreateDataObjectsResponse;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\CreateDataObjectRequest;
use Google\Cloud\VectorSearch\V1\DataObject;

/**
 * @param string $formattedParent         The resource name of the Collection to create the DataObjects in.
 *                                        Format: `projects/{project}/locations/{location}/collections/{collection}`.
 *                                        The parent field in the CreateDataObjectRequest messages must match this
 *                                        field. Please see
 *                                        {@see DataObjectServiceClient::collectionName()} for help formatting this field.
 * @param string $formattedRequestsParent The resource name of the Collection to create the DataObject in.
 *                                        Format: `projects/{project}/locations/{location}/collections/{collection}`
 *                                        Please see {@see DataObjectServiceClient::collectionName()} for help formatting this field.
 * @param string $requestsDataObjectId    The id of the dataObject to create.
 *                                        The id must be 1-63 characters long, and comply with
 *                                        [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
 *                                        Specifically, it must be 1-63 characters long and match the regular
 *                                        expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
 */
function batch_create_data_objects_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsDataObjectId
): void {
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $requestsDataObject = new DataObject();
    $createDataObjectRequest = (new CreateDataObjectRequest())
        ->setParent($formattedRequestsParent)
        ->setDataObjectId($requestsDataObjectId)
        ->setDataObject($requestsDataObject);
    $requests = [$createDataObjectRequest,];
    $request = (new BatchCreateDataObjectsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateDataObjectsResponse $response */
        $response = $dataObjectServiceClient->batchCreateDataObjects($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 = DataObjectServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );
    $formattedRequestsParent = DataObjectServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );
    $requestsDataObjectId = '[DATA_OBJECT_ID]';

    batch_create_data_objects_sample($formattedParent, $formattedRequestsParent, $requestsDataObjectId);
}

batchDeleteDataObjects

Deletes dataObjects in a batch.

The async variant is DataObjectServiceClient::batchDeleteDataObjectsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\BatchDeleteDataObjectsRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\BatchDeleteDataObjectsRequest;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\DeleteDataObjectRequest;

/**
 * @param string $formattedParent       The resource name of the Collection to delete the DataObjects in.
 *                                      Format: `projects/{project}/locations/{location}/collections/{collection}`. Please see
 *                                      {@see DataObjectServiceClient::collectionName()} for help formatting this field.
 * @param string $formattedRequestsName The name of the DataObject resource to be deleted.
 *                                      Format:
 *                                      `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`
 *                                      Please see {@see DataObjectServiceClient::dataObjectName()} for help formatting this field.
 */
function batch_delete_data_objects_sample(
    string $formattedParent,
    string $formattedRequestsName
): void {
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $deleteDataObjectRequest = (new DeleteDataObjectRequest())
        ->setName($formattedRequestsName);
    $requests = [$deleteDataObjectRequest,];
    $request = (new BatchDeleteDataObjectsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        $dataObjectServiceClient->batchDeleteDataObjects($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
{
    $formattedParent = DataObjectServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );
    $formattedRequestsName = DataObjectServiceClient::dataObjectName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[DATAOBJECT]'
    );

    batch_delete_data_objects_sample($formattedParent, $formattedRequestsName);
}

batchUpdateDataObjects

Updates dataObjects in a batch.

The async variant is DataObjectServiceClient::batchUpdateDataObjectsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\BatchUpdateDataObjectsRequest` 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\VectorSearch\V1\BatchUpdateDataObjectsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\BatchUpdateDataObjectsRequest;
use Google\Cloud\VectorSearch\V1\BatchUpdateDataObjectsResponse;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\DataObject;
use Google\Cloud\VectorSearch\V1\UpdateDataObjectRequest;

/**
 * @param string $formattedParent The resource name of the Collection to update the DataObjects in.
 *                                Format: `projects/{project}/locations/{location}/collections/{collection}`.
 *                                The parent field in the UpdateDataObjectRequest messages must match this
 *                                field. Please see
 *                                {@see DataObjectServiceClient::collectionName()} for help formatting this field.
 */
function batch_update_data_objects_sample(string $formattedParent): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $requestsDataObject = new DataObject();
    $updateDataObjectRequest = (new UpdateDataObjectRequest())
        ->setDataObject($requestsDataObject);
    $requests = [$updateDataObjectRequest,];
    $request = (new BatchUpdateDataObjectsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateDataObjectsResponse $response */
        $response = $dataObjectServiceClient->batchUpdateDataObjects($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 = DataObjectServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );

    batch_update_data_objects_sample($formattedParent);
}

createDataObject

Creates a dataObject.

The async variant is DataObjectServiceClient::createDataObjectAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\CreateDataObjectRequest` 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\VectorSearch\V1\DataObject`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\CreateDataObjectRequest;
use Google\Cloud\VectorSearch\V1\DataObject;

/**
 * @param string $formattedParent The resource name of the Collection to create the DataObject in.
 *                                Format: `projects/{project}/locations/{location}/collections/{collection}`
 *                                Please see {@see DataObjectServiceClient::collectionName()} for help formatting this field.
 * @param string $dataObjectId    The id of the dataObject to create.
 *                                The id must be 1-63 characters long, and comply with
 *                                [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
 *                                Specifically, it must be 1-63 characters long and match the regular
 *                                expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
 */
function create_data_object_sample(string $formattedParent, string $dataObjectId): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $dataObject = new DataObject();
    $request = (new CreateDataObjectRequest())
        ->setParent($formattedParent)
        ->setDataObjectId($dataObjectId)
        ->setDataObject($dataObject);

    // Call the API and handle any network failures.
    try {
        /** @var DataObject $response */
        $response = $dataObjectServiceClient->createDataObject($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 = DataObjectServiceClient::collectionName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]'
    );
    $dataObjectId = '[DATA_OBJECT_ID]';

    create_data_object_sample($formattedParent, $dataObjectId);
}

deleteDataObject

Deletes a dataObject.

The async variant is DataObjectServiceClient::deleteDataObjectAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\DeleteDataObjectRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\DeleteDataObjectRequest;

/**
 * @param string $formattedName The name of the DataObject resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`
 *                              Please see {@see DataObjectServiceClient::dataObjectName()} for help formatting this field.
 */
function delete_data_object_sample(string $formattedName): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $dataObjectServiceClient->deleteDataObject($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 = DataObjectServiceClient::dataObjectName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[DATAOBJECT]'
    );

    delete_data_object_sample($formattedName);
}

getDataObject

Gets a data object.

The async variant is DataObjectServiceClient::getDataObjectAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\GetDataObjectRequest` 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\VectorSearch\V1\DataObject`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\DataObject;
use Google\Cloud\VectorSearch\V1\GetDataObjectRequest;

/**
 * @param string $formattedName The name of the DataObject resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`
 *                              Please see {@see DataObjectServiceClient::dataObjectName()} for help formatting this field.
 */
function get_data_object_sample(string $formattedName): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataObject $response */
        $response = $dataObjectServiceClient->getDataObject($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 = DataObjectServiceClient::dataObjectName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[DATAOBJECT]'
    );

    get_data_object_sample($formattedName);
}

updateDataObject

Updates a dataObject.

The async variant is DataObjectServiceClient::updateDataObjectAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\UpdateDataObjectRequest` 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\VectorSearch\V1\DataObject`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;
use Google\Cloud\VectorSearch\V1\DataObject;
use Google\Cloud\VectorSearch\V1\UpdateDataObjectRequest;

/**
 * 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_data_object_sample(): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $dataObject = new DataObject();
    $request = (new UpdateDataObjectRequest())
        ->setDataObject($dataObject);

    // Call the API and handle any network failures.
    try {
        /** @var DataObject $response */
        $response = $dataObjectServiceClient->updateDataObject($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getLocation

Gets information about a location.

The async variant is DataObjectServiceClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` 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\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $dataObjectServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

This method can be called in two ways:

List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

The async variant is DataObjectServiceClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` 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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\VectorSearch\V1\Client\DataObjectServiceClient;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $dataObjectServiceClient = new DataObjectServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

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

batchCreateDataObjectsAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\BatchCreateDataObjectsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\VectorSearch\V1\BatchCreateDataObjectsResponse>`

batchDeleteDataObjectsAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\BatchDeleteDataObjectsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

batchUpdateDataObjectsAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\BatchUpdateDataObjectsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\VectorSearch\V1\BatchUpdateDataObjectsResponse>`

createDataObjectAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\CreateDataObjectRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\VectorSearch\V1\DataObject>`

deleteDataObjectAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\DeleteDataObjectRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

getDataObjectAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\GetDataObjectRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\VectorSearch\V1\DataObject>`

updateDataObjectAsync

Parameters
Name	Description
`request`	`Google\Cloud\VectorSearch\V1\UpdateDataObjectRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\VectorSearch\V1\DataObject>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

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

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

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

Returns
Type	Description
`string`	The formatted data_object 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}
dataObject: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

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.

Google Cloud Vector Search V1 Client - Class DataObjectServiceClient (0.2.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

batchCreateDataObjects

batchDeleteDataObjects

batchUpdateDataObjects

createDataObject

deleteDataObject

getDataObject

updateDataObject

getLocation

listLocations

batchCreateDataObjectsAsync

batchDeleteDataObjectsAsync

batchUpdateDataObjectsAsync

createDataObjectAsync

deleteDataObjectAsync

getDataObjectAsync

updateDataObjectAsync

getLocationAsync

listLocationsAsync

static::collectionName

static::dataObjectName

static::parseName

Google Cloud Vector Search V1 Client - Class DataObjectServiceClient (0.2.0)