Method: projects.locations.collections.importDataObjects

Initiates a Long-Running Operation to import DataObjects into a Collection.

HTTP request

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

Path parameters

Parameters
name

string

Required. The resource name of the Collection to import DataObjects into. Format: projects/{project}/locations/{location}/collections/{collection}.

Request body

The request body contains data with the following structure:

JSON representation 
{

  // Union field config can be only one of the following:
  "gcsImport": {
    object (GcsImportConfig)
  }
  // End of list of possible types for union field config.
}
Fields
Union field config. The configuration for the import data and error results. config can be only one of the following:
gcsImport

object (GcsImportConfig)

The Cloud Storage location of the input content.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • vectorsearch.dataObjects.import

For more information, see the IAM documentation.

GcsImportConfig

Google Cloud Storage configuration for the import.

JSON representation 
{
  "contentsUri": string,
  "errorUri": string,
  "outputUri": string
}
Fields
contentsUri

string

Required. URI prefix of the Cloud Storage DataObjects to import.
errorUri

string

Required. URI prefix of the Cloud Storage location to write any errors encountered during the import.
outputUri

string

Optional. URI prefix of the Cloud Storage location to write DataObject IDs and etags of DataObjects that were successfully imported. The service will write the successfully imported DataObjects to sharded files under this prefix. If this field is empty, no output will be written.