Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.engines.operations.list

  HTTP Method : GET

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations

  Path : v1alpha/{+name}/operations

  Parameter Order : name

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

  Parameters :

  name

  Type : string

  Description : The name of the operation's parent resource.

  Required : Yes

  Location : path

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

  pageToken

  Location : query

  Description : The standard list page token.

  Type : string

  filter

  Type : string

  Description : The standard list filter.

  Location : query

  pageSize

  Type : integer

  Description : The standard list page size.

  Format : int32

  Location : query

  Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.purge

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge

  Parameters :

  parent

  Location : path

  Type : string

  Description : Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.

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

  Required : Yes

  Parameter Order : parent

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

  Path : v1alpha/{+parent}/documents:purge

  Description : Permanently deletes all selected Documents under a branch. This process is asynchronous. If the request is valid, the removal will be enquired and processed offlines. Depending on the number of Documents, this operation could take hours to complete. Before the operation completes, some Documents may still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a sample of Documents that would be deleted, set PurgeDocumentsRequest.force to false.

  HTTP Method : POST

• ▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.purge

  Parameter Order : parent

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

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge

  Path : v1alpha/{+parent}/documents:purge

  Description : Permanently deletes all selected Documents under a branch. This process is asynchronous. If the request is valid, the removal will be enquired and processed offlines. Depending on the number of Documents, this operation could take hours to complete. Before the operation completes, some Documents may still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a sample of Documents that would be deleted, set PurgeDocumentsRequest.force to false.

  Parameters :

  parent

  Location : path

  Type : string

  Required : Yes

  Description : Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.

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

  HTTP Method : POST