Method: projects.locations.setUpDataConnector
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{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 the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint is used to create a new Collection and set up its associated DataConnector."],["The HTTP request uses a POST method to a specific URL structure, with a required `parent` path parameter."],["The request body is structured in JSON format and requires fields such as `collectionId`, `collectionDisplayName`, and a nested `dataConnector` object."],["The `collectionId` is a required unique identifier for the Collection, and it should follow the RFC-1034 standard, while `collectionDisplayName` is a user-friendly name for the collection."],["Upon success, the response will contain an Operation instance, and the request requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
