Method: projects.locations.setUpDataConnector

Cria uma Collection e configura o DataConnector para ela. Para interromper um DataConnector após a configuração, use o método CollectionService.DeleteCollection.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai de Collection, no formato projects/{project}/locations/{location}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "collectionId": string,
  "collectionDisplayName": string,
  "dataConnector": {
    object (DataConnector)
  }
}
Campos
collectionId

string

Obrigatório. O ID a ser usado para o Collection, que se tornará o componente final do nome do recurso do Collection. Uma nova Collection é criada como parte da configuração do DataConnector. DataConnector é um recurso singleton em Collection, que gerencia todos os DataStores da Collection.

Precisa estar em conformidade com o padrão RFC-1034 com um limite de comprimento de 63 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.

collectionDisplayName

string

Obrigatório. O nome de exibição da Collection.

Precisa ser legível e usado para exibir coleções no painel do console. String codificada em UTF-8 com limite de 1.024 caracteres.

dataConnector

object (DataConnector)

Obrigatório. O DataConnector a ser inicializado na Collection recém-criada.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.locations.setUpDataConnector

Para mais informações, consulte a documentação do IAM.