Method: projects.locations.collections.exportDataObjects

Initiates a Long-Running Operation to export DataObjects from a Collection.

HTTP request

POST https://vectorsearch.googleapis.com/v1beta/{name}:exportDataObjects

Path parameters

Parameters
name

string

Required. The resource name of the Collection from which we want to export Data Objects. Format: projects/{project}/locations/{location}/collections/{collection}.

Request body

The request body contains data with the following structure:

JSON representation 
{

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsExportDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
Union field destination. The configuration for the export data. destination can be only one of the following:
gcsDestination

object (GcsExportDestination)

The Cloud Storage location where user wants to export Data Objects.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GcsExportDestination

Google Cloud Storage configuration for the export.

JSON representation 
{
  "exportUri": string,
  "format": enum (Format)
}
Fields
exportUri

string

Required. URI prefix of the Cloud Storage where to export Data Objects. The bucket is required to be in the same region as the collection.
format

enum (Format)

Required. The format of the exported Data Objects.

Format

Options for the format of the exported Data Objects. New formats may be added in the future.

Enums
FORMAT_UNSPECIFIED Unspecified format.
JSON The exported Data Objects will be in JSON format.