Method: projects.locations.setUpDataConnector

Erstellt ein Collection-Objekt und richtet das DataConnector-Objekt dafür ein. Verwenden Sie zum Beenden einer DataConnector nach der Einrichtung die Methode CollectionService.DeleteCollection.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Das übergeordnete Element von Collection im Format projects/{project}/locations/{location}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "collectionId": string,
  "collectionDisplayName": string,
  "dataConnector": {
    object (DataConnector)
  }
}
Felder
collectionId

string

Erforderlich. Die für Collection zu verwendende ID, die als letzte Komponente des Ressourcennamens von Collection verwendet wird. Im Rahmen der Einrichtung von DataConnector wird ein neues Collection erstellt. DataConnector ist eine Singleton-Ressource unter Collection, die alle DataStores von Collection verwaltet.

Dieses Feld muss dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

collectionDisplayName

string

Erforderlich. Der Anzeigename von Collection.

Sollte für Menschen lesbar sein und wird verwendet, um Sammlungen im Console-Dashboard anzuzeigen. UTF-8-codierter String mit einem Limit von 1.024 Zeichen.

dataConnector

object (DataConnector)

Erforderlich. Die DataConnector, die in der neu erstellten Collection initialisiert werden soll.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.locations.setUpDataConnector

Weitere Informationen finden Sie in der IAM-Dokumentation.