com.google.api.services.cloudsearch.v1

Class CloudSearch.Indexing.Datasources.Items

java.lang.Object

com.google.api.services.cloudsearch.v1.CloudSearch.Indexing.Datasources.Items

Enclosing class:

CloudSearch.Indexing.Datasources

public class CloudSearch.Indexing.Datasources.Items
extends java.lang.Object

The "items" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudSearch.Indexing.Datasources.Items.Delete
class	CloudSearch.Indexing.Datasources.Items.DeleteQueueItems
class	CloudSearch.Indexing.Datasources.Items.Get
class	CloudSearch.Indexing.Datasources.Items.Index
class	CloudSearch.Indexing.Datasources.Items.List
class	CloudSearch.Indexing.Datasources.Items.Poll
class	CloudSearch.Indexing.Datasources.Items.Push
class	CloudSearch.Indexing.Datasources.Items.Unreserve
class	CloudSearch.Indexing.Datasources.Items.Upload

Constructor Summary

Constructors

Constructor and Description
Items()

Method Summary

Modifier and Type	Method and Description
CloudSearch.Indexing.Datasources.Items.Delete	delete(java.lang.String name) Deletes Item resource for the specified resource name.
CloudSearch.Indexing.Datasources.Items.DeleteQueueItems	deleteQueueItems(java.lang.String name, DeleteQueueItemsRequest content) Deletes all items in a queue.
CloudSearch.Indexing.Datasources.Items.Get	get(java.lang.String name) Gets Item resource by item name.
CloudSearch.Indexing.Datasources.Items.Index	index(java.lang.String name, IndexItemRequest content) Updates Item ACL, metadata, and content.
CloudSearch.Indexing.Datasources.Items.List	list(java.lang.String name) Lists all or a subset of Item resources.
CloudSearch.Indexing.Datasources.Items.Poll	poll(java.lang.String name, PollItemsRequest content) 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.
CloudSearch.Indexing.Datasources.Items.Push	push(java.lang.String name, PushItemRequest content) Pushes an item onto a queue for later polling and updating.
CloudSearch.Indexing.Datasources.Items.Unreserve	unreserve(java.lang.String name, UnreserveItemsRequest content) Unreserves all items from a queue, making them all eligible to be polled.
CloudSearch.Indexing.Datasources.Items.Upload	upload(java.lang.String name, StartUploadItemRequest content) Creates an upload session for uploading item content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Items

public Items()

Method Detail

delete

public CloudSearch.Indexing.Datasources.Items.Delete delete(java.lang.String name)
                                                     throws java.io.IOException

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. Create a request for the method "items.delete". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id}

Returns:

the request

Throws:

java.io.IOException

deleteQueueItems

public CloudSearch.Indexing.Datasources.Items.DeleteQueueItems deleteQueueItems(java.lang.String name,
                                                                                DeleteQueueItemsRequest content)
                                                                         throws java.io.IOException

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. Create a request for the method "items.deleteQueueItems". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the Data Source to delete items in a queue. Format: datasources/{source_id}

content - the DeleteQueueItemsRequest

Returns:

the request

Throws:

java.io.IOException

get

public CloudSearch.Indexing.Datasources.Items.Get get(java.lang.String name)
                                               throws java.io.IOException

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. Create a request for the method "items.get". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the item to get info. Format: datasources/{source_id}/items/{item_id}

Returns:

the request

Throws:

java.io.IOException

index

public CloudSearch.Indexing.Datasources.Items.Index index(java.lang.String name,
                                                          IndexItemRequest content)
                                                   throws java.io.IOException

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. Create a request for the method "items.index". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.

content - the IndexItemRequest

Returns:

the request

Throws:

java.io.IOException

list

public CloudSearch.Indexing.Datasources.Items.List list(java.lang.String name)
                                                 throws java.io.IOException

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. Create a request for the method "items.list". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the Data Source to list Items. Format: datasources/{source_id}

Returns:

the request

Throws:

java.io.IOException

poll

public CloudSearch.Indexing.Datasources.Items.Poll poll(java.lang.String name,
                                                        PollItemsRequest content)
                                                 throws java.io.IOException

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. Create a request for the method "items.poll". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the Data Source to poll items. Format: datasources/{source_id}

content - the PollItemsRequest

Returns:

the request

Throws:

java.io.IOException

push

public CloudSearch.Indexing.Datasources.Items.Push push(java.lang.String name,
                                                        PushItemRequest content)
                                                 throws java.io.IOException

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. Create a request for the method "items.push". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - 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.

content - the PushItemRequest

Returns:

the request

Throws:

java.io.IOException

unreserve

public CloudSearch.Indexing.Datasources.Items.Unreserve unreserve(java.lang.String name,
                                                                  UnreserveItemsRequest content)
                                                           throws java.io.IOException

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. Create a request for the method "items.unreserve". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the Data Source to unreserve all items. Format: datasources/{source_id}

content - the UnreserveItemsRequest

Returns:

the request

Throws:

java.io.IOException

upload

public CloudSearch.Indexing.Datasources.Items.Upload upload(java.lang.String name,
                                                            StartUploadItemRequest content)
                                                     throws java.io.IOException

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. Create a request for the method "items.upload". This request holds the parameters needed by the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}.

content - the StartUploadItemRequest

Returns:

the request

Throws:

java.io.IOException