Documentation

Google_Service_CloudSearch_Resource_IndexingDatasourcesItems extends Google_Service_Resource
in package

The "items" collection of methods.

Typical usage is: $cloudsearchService = new Google_Service_CloudSearch(...); $items = $cloudsearchService->items;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudSearch_Operation
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)
deleteQueueItems()  : Google_Service_CloudSearch_Operation
Deletes all items in a queue. This method is useful for deleting stale items.
get()  : Google_Service_CloudSearch_Item
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)
index()  : Google_Service_CloudSearch_Operation
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)
listIndexingDatasourcesItems()  : Google_Service_CloudSearch_ListItemsResponse
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)
poll()  : Google_Service_CloudSearch_PollItemsResponse
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)
push()  : Google_Service_CloudSearch_Item
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)
unreserve()  : Google_Service_CloudSearch_Operation
Unreserves all items from a queue, making them all eligible to be polled.
upload()  : Google_Service_CloudSearch_UploadItemRef
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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

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. (items.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_Operation
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

opt_param

string version 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.

opt_param

string mode Required. The RequestMode for this request.

opt_param

string connectorName Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}

Return values
Google_Service_CloudSearch_Operation —

deleteQueueItems()

Deletes all items in a queue. This method is useful for deleting stale items.

public deleteQueueItems(string $name, Google_Service_CloudSearch_DeleteQueueItemsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_Operation

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)

Parameters
$name : string

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

$postBody : Google_Service_CloudSearch_DeleteQueueItemsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_Operation —

get()

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)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_Item
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

opt_param

string connectorName Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}

Return values
Google_Service_CloudSearch_Item —

index()

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)

public index(string $name, Google_Service_CloudSearch_IndexItemRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_Operation
Parameters
$name : string

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

$postBody : Google_Service_CloudSearch_IndexItemRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_Operation —

listIndexingDatasourcesItems()

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)

public listIndexingDatasourcesItems(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_ListItemsResponse
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. The default value is 10

opt_param

bool brief When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.

opt_param

bool debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

opt_param

string connectorName Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}

opt_param

string pageToken The next_page_token value returned from a previous List request, if any.

Return values
Google_Service_CloudSearch_ListItemsResponse —

poll()

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)

public poll(string $name, Google_Service_CloudSearch_PollItemsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_PollItemsResponse
Parameters
$name : string

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

$postBody : Google_Service_CloudSearch_PollItemsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_PollItemsResponse —

push()

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)

public push(string $name, Google_Service_CloudSearch_PushItemRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_Item
Parameters
$name : string

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.

$postBody : Google_Service_CloudSearch_PushItemRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_Item —

unreserve()

Unreserves all items from a queue, making them all eligible to be polled.

public unreserve(string $name, Google_Service_CloudSearch_UnreserveItemsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_Operation

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)

Parameters
$name : string

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

$postBody : Google_Service_CloudSearch_UnreserveItemsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_Operation —

upload()

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)

public upload(string $name, Google_Service_CloudSearch_StartUploadItemRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_UploadItemRef
Parameters
$name : string

Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes.

$postBody : Google_Service_CloudSearch_StartUploadItemRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_UploadItemRef —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results