Discovery Engine API (discoveryengine:v1)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.setUpDataConnector

  Path : v1/{+parent}:setUpDataConnector

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnector

  HTTP Method : POST

  Parameters :

  parent

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

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

  Scopes : https://www.googleapis.com/auth/cloud-platform

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

• ▼ ▲ discoveryengine.projects.locations.setUpDataConnectorV2

  Path : v1/{+parent}:setUpDataConnectorV2

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2

  HTTP Method : POST

  Parameters :

  parent

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

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Required : Yes

  Type : string

  collectionId

  Description : 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  Location : query

  Type : string

  collectionDisplayName

  Description : 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.

  Location : query

  Type : string

  Parameter Order : parent

  Scopes : https://www.googleapis.com/auth/cloud-platform

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

• ▼ ▲ discoveryengine.projects.locations.collections.delete

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`.

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Deletes a Collection.

• ▼ ▲ discoveryengine.projects.locations.collections.getDataConnector

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector

  HTTP Method : GET

  Parameters :

  name

  Description : Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Gets the DataConnector. DataConnector is a singleton resource for each Collection.

• ▼ ▲ discoveryengine.projects.locations.collections.updateDataConnector

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector

  HTTP Method : PATCH

  Parameters :

  name

  Description : Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$

  Location : path

  Required : Yes

  Type : string

  updateMask

  Description : Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.

  Location : query

  Type : string

  Format : google-fieldmask

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Updates a DataConnector.