GoogleApi.CloudSearch.V1.Api.Indexing.cloudsearch_indexing_datasources_items_poll
You're seeing just the function
cloudsearch_indexing_datasources_items_poll
, go back to GoogleApi.CloudSearch.V1.Api.Indexing module for more information.
Link to this function
cloudsearch_indexing_datasources_items_poll(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_indexing_datasources_items_poll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.PollItemsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the Data Source to poll items. Format: datasources/{source_id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudSearch.V1.Model.PollItemsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.PollItemsResponse{}}
on success -
{:error, info}
on failure