Class IndexingResource.DatasourcesResource.ItemsResource.PollRequest

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.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<PollItemsResponse>
CloudSearchBaseServiceRequest<PollItemsResponse>
IndexingResource.DatasourcesResource.ItemsResource.PollRequest
Implements
Google.Apis.Requests.IClientServiceRequest<PollItemsResponse>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudSearch.v1
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class PollRequest : CloudSearchBaseServiceRequest<PollItemsResponse>, IClientServiceRequest<PollItemsResponse>, IClientServiceRequest

Constructors

PollRequest(IClientService, PollItemsRequest, String)

Constructs a new Poll request.

Declaration
public PollRequest(IClientService service, PollItemsRequest body, string name)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
PollItemsRequest body
System.String name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.MethodName

Name

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

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.GetBody()

InitParameters()

Initializes Poll parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudSearch.v1.CloudSearchBaseServiceRequest<Google.Apis.CloudSearch.v1.Data.PollItemsResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest