2023-04-28
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.purge
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+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.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge
Parameter Order : parent
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location : path
Description : Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Type : string
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Description : Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$
Type : string
Path : v1beta/{+parent}/documents:purge
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge
▼ ▲ discoveryengine.projects.locations.collections.engines.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameter Order : name
Parameters :
pageToken
Type : string
Description : The standard list page token.
Location : query
pageSize
Description : The standard list page size.
Format : int32
Location : query
Type : integer
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Description : The name of the operation's parent resource.
filter
Location : query
Description : The standard list filter.
Type : string
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations
Path : v1beta/{+name}/operations