Method: indexing.datasources.items.deleteQueueItems
Stay organized with collections
Save and categorize content based on your preferences.
Deletes all items in a queue. This method is useful for deleting stale items.
This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
HTTP request
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:deleteQueueItems
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The name of the data Source to delete items in a queue. Format: datasources/{sourceId}
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"connectorName": string,
"queue": string,
"debugOptions": {
object (DebugOptions)
}
} |
| Fields |
connectorName |
string
The name of connector making this call. Format: datasources/{sourceId}/connectors/{id}
|
queue |
string
The name of a queue to delete items from.
|
debugOptions |
object (DebugOptions)
Common debug options.
|
Response body
If successful, the response body contains an instance of Operation.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud_search.indexinghttps://www.googleapis.com/auth/cloud_search
For more information, see the Authorization guide.
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-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Method: indexing.datasources.items.deleteQueueItems\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeletes all items in a queue. This method is useful for deleting stale items.\n\nThis API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.\n\n### HTTP request\n\n`POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:deleteQueueItems`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the data Source to delete items in a queue. Format: datasources/{sourceId} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"connectorName\": string, \"queue\": string, \"debugOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/DebugOptions) } } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------|\n| `connectorName` | `string` The name of connector making this call. Format: datasources/{sourceId}/connectors/{id} |\n| `queue` | `string` The name of a queue to delete items from. |\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.indexing`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
