IndexingDatasourcesItems
class IndexingDatasourcesItems extends Resource (View source)
The "items" collection of methods.
Typical usage is:
$cloudsearchService = new Google\Service\CloudSearch(...);
$items = $cloudsearchService->indexing_datasources_items;Methods
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. (items.delete)
Deletes all items in a queue. This method is useful for deleting stale items.
Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.get)
Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.index)
Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.listIndexingDatasourcesItems)
Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.poll)
Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.push)
Unreserves all items from a queue, making them all eligible to be polled.
Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.upload)
Details
Operation
delete(string $name, array $optParams = [])
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. (items.delete)
Operation
deleteQueueItems(string $name, DeleteQueueItemsRequest $postBody, array $optParams = [])
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. (items.deleteQueueItems)
Item
get(string $name, array $optParams = [])
Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.get)
Operation
index(string $name, IndexItemRequest $postBody, array $optParams = [])
Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.index)
ListItemsResponse
listIndexingDatasourcesItems(string $name, array $optParams = [])
Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.listIndexingDatasourcesItems)
PollItemsResponse
poll(string $name, PollItemsRequest $postBody, array $optParams = [])
Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.poll)
Item
push(string $name, PushItemRequest $postBody, array $optParams = [])
Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.push)
Operation
unreserve(string $name, UnreserveItemsRequest $postBody, array $optParams = [])
Unreserves all items from a queue, making them all eligible to be polled.
This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.unreserve)
UploadItemRef
upload(string $name, StartUploadItemRequest $postBody, array $optParams = [])
Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. (items.upload)