Method: projects.locations.setUpDataConnector

Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

HTTP request

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*}:setUpDataConnector

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of Collection, in the format of projects/{project}/locations/{location}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "collectionId": string,
  "collectionDisplayName": string,
  "dataConnector": {
    object (DataConnector)
  }
}
Fields
collectionId

string

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName

string

Required. The display name of the Collection.

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector

object (DataConnector)

Required. The DataConnector to initialize in the newly created Collection.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.locations.setUpDataConnector

For more information, see the IAM documentation.