2024-12-18
▼ ▲ discoveryengine.projects.locations.setUpDataConnector
Path : v1alpha/{+parent}:setUpDataConnector
Flat Path : v1alpha/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.generateGroundedContent
Path : v1alpha/{+location}:generateGroundedContent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:generateGroundedContent
HTTP Method : POST
Parameters :
location
Description : Required. Location resource. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : location
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Generates grounded content.
▼ ▲ discoveryengine.projects.locations.collections.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The full resource name, 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 : Gets a Collection.
▼ ▲ discoveryengine.projects.locations.collections.list
Path : v1alpha/{+parent}/collections
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections
HTTP Method : GET
Parameters :
parent
Description : Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token.
Location : query
Type : string
filter
Description : Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a list of Collections.
▼ ▲ discoveryengine.projects.locations.collections.patch
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Collection.
▼ ▲ discoveryengine.projects.locations.collections.delete
Path : v1alpha/{+name}
Flat Path : v1alpha/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 : v1alpha/{+name}
Flat Path : v1alpha/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 : v1alpha/{+name}
Flat Path : v1alpha/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 - destination_configs - blocking_reasons 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.
▼ ▲ discoveryengine.projects.locations.collections.dataConnector.startConnectorRun
Path : v1alpha/{+parent}:startConnectorRun
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:startConnectorRun
HTTP Method : POST
Parameters :
parent
Description : Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.
▼ ▲ discoveryengine.projects.locations.collections.dataConnector.connectorRuns.list
Path : v1alpha/{+parent}/connectorRuns
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/connectorRuns
HTTP Method : GET
Parameters :
parent
Description : Required. The parent DataConnector resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$
Location : path
Required : Yes
Type : string
pageSize
Description : Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the ConnectorRuns of a DataConnector.