Method: indexing.datasources.items.delete

Deletes Item resource for the specified resource name. 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

DELETE https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*/items/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the item to delete. Format: datasources/{sourceId}/items/{itemId}

Query parameters

Parameters
version

string (bytes format)

Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering.

Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.

For information on how item version affects the deletion process, refer to Handle revisions after manual deletes.

A base64-encoded string.
connectorName

string

The name of connector making this call.

Format: datasources/{sourceId}/connectors/{id}
mode

enum (RequestMode.Mode)

Required. The RequestMode for this request.
debugOptions

object (DebugOptions)

Common debug options.

Request body

The request body must be empty.

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.indexing
  • https://www.googleapis.com/auth/cloud_search

For more information, see the Authorization guide.