Class IndexingResource.DatasourcesResource.ItemsResource

The "items" collection of methods.

Inheritance

object

IndexingResource.DatasourcesResource.ItemsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudSearch.v1

Assembly: Google.Apis.CloudSearch.v1.dll

Syntax

public class IndexingResource.DatasourcesResource.ItemsResource

Constructors

ItemsResource(IClientService)

Constructs a new resource.

Declaration

public ItemsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Delete(string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the item to delete. Format: datasources/{source_id}/items/{item_id}

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.DeleteRequest

DeleteQueueItems(DeleteQueueItemsRequest, string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.DeleteQueueItemsRequest DeleteQueueItems(DeleteQueueItemsRequest body, string name)

Parameters

Type	Name	Description
DeleteQueueItemsRequest	body	The body of the request.
string	name	The name of the Data Source to delete items in a queue. Format: datasources/{source_id}

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.DeleteQueueItemsRequest

Get(string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	The name of the item to get info. Format: datasources/{source_id}/items/{item_id}

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.GetRequest

Index(IndexItemRequest, string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.IndexRequest Index(IndexItemRequest body, string name)

Parameters

Type	Name	Description
IndexItemRequest	body	The body of the request.
string	name	The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.IndexRequest

List(string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.ListRequest List(string name)

Parameters

Type	Name	Description
string	name	The name of the Data Source to list Items. Format: datasources/{source_id}

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.ListRequest

Poll(PollItemsRequest, string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.PollRequest Poll(PollItemsRequest body, string name)

Parameters

Type	Name	Description
PollItemsRequest	body	The body of the request.
string	name	The name of the Data Source to poll items. Format: datasources/{source_id}

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.PollRequest

Push(PushItemRequest, string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.PushRequest Push(PushItemRequest body, string name)

Parameters

Type	Name	Description
PushItemRequest	body	The body of the request.
string	name	The name of the item to push into the indexing queue. Format: datasources/{source_id}/items/{ID} This is a required field. The maximum length is 1536 characters.

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.PushRequest

Unreserve(UnreserveItemsRequest, string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.UnreserveRequest Unreserve(UnreserveItemsRequest body, string name)

Parameters

Type	Name	Description
UnreserveItemsRequest	body	The body of the request.
string	name	The name of the Data Source to unreserve all items. Format: datasources/{source_id}

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.UnreserveRequest

Upload(StartUploadItemRequest, string)

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.

Declaration

public virtual IndexingResource.DatasourcesResource.ItemsResource.UploadRequest Upload(StartUploadItemRequest body, string name)

Parameters

Type	Name	Description
StartUploadItemRequest	body	The body of the request.
string	name	The name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes.

Returns

Type	Description
IndexingResource.DatasourcesResource.ItemsResource.UploadRequest