Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll

Contents

REST Resource
Creating a Request
Request Lenses

Description

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.

See: Cloud Search API Reference for cloudsearch.indexing.datasources.items.poll.

Synopsis

type IndexingDatasourcesItemsPollResource = "v1" :> ("indexing" :> (Capture "name" Text :> ("items:poll" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PollItemsRequest :> Post '[JSON] PollItemsResponse))))))))))
indexingDatasourcesItemsPoll :: PollItemsRequest -> Text -> IndexingDatasourcesItemsPoll
data IndexingDatasourcesItemsPoll
idipdXgafv :: Lens' IndexingDatasourcesItemsPoll (Maybe Xgafv)
idipdUploadProtocol :: Lens' IndexingDatasourcesItemsPoll (Maybe Text)
idipdAccessToken :: Lens' IndexingDatasourcesItemsPoll (Maybe Text)
idipdUploadType :: Lens' IndexingDatasourcesItemsPoll (Maybe Text)
idipdPayload :: Lens' IndexingDatasourcesItemsPoll PollItemsRequest
idipdName :: Lens' IndexingDatasourcesItemsPoll Text
idipdCallback :: Lens' IndexingDatasourcesItemsPoll (Maybe Text)

REST Resource

type IndexingDatasourcesItemsPollResource = "v1" :> ("indexing" :> (Capture "name" Text :> ("items:poll" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PollItemsRequest :> Post '[JSON] PollItemsResponse)))))))))) Source #

A resource alias for cloudsearch.indexing.datasources.items.poll method which the IndexingDatasourcesItemsPoll request conforms to.

Creating a Request

indexingDatasourcesItemsPoll Source #

Arguments

:: PollItemsRequest	`idipdPayload`
-> Text	`idipdName`
-> IndexingDatasourcesItemsPoll

Creates a value of IndexingDatasourcesItemsPoll with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data IndexingDatasourcesItemsPoll Source #

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.

See: indexingDatasourcesItemsPoll smart constructor.

Instances

Eq IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll Methods (==) :: IndexingDatasourcesItemsPoll -> IndexingDatasourcesItemsPoll -> Bool # (/=) :: IndexingDatasourcesItemsPoll -> IndexingDatasourcesItemsPoll -> Bool #
Data IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IndexingDatasourcesItemsPoll -> c IndexingDatasourcesItemsPoll # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IndexingDatasourcesItemsPoll # toConstr :: IndexingDatasourcesItemsPoll -> Constr # dataTypeOf :: IndexingDatasourcesItemsPoll -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IndexingDatasourcesItemsPoll) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IndexingDatasourcesItemsPoll) # gmapT :: (forall b. Data b => b -> b) -> IndexingDatasourcesItemsPoll -> IndexingDatasourcesItemsPoll # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IndexingDatasourcesItemsPoll -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IndexingDatasourcesItemsPoll -> r # gmapQ :: (forall d. Data d => d -> u) -> IndexingDatasourcesItemsPoll -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> IndexingDatasourcesItemsPoll -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> IndexingDatasourcesItemsPoll -> m IndexingDatasourcesItemsPoll # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexingDatasourcesItemsPoll -> m IndexingDatasourcesItemsPoll # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexingDatasourcesItemsPoll -> m IndexingDatasourcesItemsPoll #
Show IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll Methods showsPrec :: Int -> IndexingDatasourcesItemsPoll -> ShowS # show :: IndexingDatasourcesItemsPoll -> String # showList :: [IndexingDatasourcesItemsPoll] -> ShowS #
Generic IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll Associated Types type Rep IndexingDatasourcesItemsPoll :: Type -> Type # Methods from :: IndexingDatasourcesItemsPoll -> Rep IndexingDatasourcesItemsPoll x # to :: Rep IndexingDatasourcesItemsPoll x -> IndexingDatasourcesItemsPoll #
GoogleRequest IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll Associated Types type Rs IndexingDatasourcesItemsPoll :: Type # type Scopes IndexingDatasourcesItemsPoll :: [Symbol] # Methods requestClient :: IndexingDatasourcesItemsPoll -> GClient (Rs IndexingDatasourcesItemsPoll) #
type Rep IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll type Rep IndexingDatasourcesItemsPoll = D1 (MetaData "IndexingDatasourcesItemsPoll" "Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "IndexingDatasourcesItemsPoll'" PrefixI True) ((S1 (MetaSel (Just "_idipdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_idipdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_idipdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_idipdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_idipdPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PollItemsRequest)) :: (S1 (MetaSel (Just "_idipdName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_idipdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll type Scopes IndexingDatasourcesItemsPoll = "https://www.googleapis.com/auth/cloud_search" ': ("https://www.googleapis.com/auth/cloud_search.indexing" ': ([] :: [Symbol]))
type Rs IndexingDatasourcesItemsPoll Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll type Rs IndexingDatasourcesItemsPoll = PollItemsResponse

Request Lenses

idipdXgafv :: Lens' IndexingDatasourcesItemsPoll (Maybe Xgafv) Source #

V1 error format.

idipdUploadProtocol :: Lens' IndexingDatasourcesItemsPoll (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

idipdAccessToken :: Lens' IndexingDatasourcesItemsPoll (Maybe Text) Source #

OAuth access token.

idipdUploadType :: Lens' IndexingDatasourcesItemsPoll (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

idipdPayload :: Lens' IndexingDatasourcesItemsPoll PollItemsRequest Source #

Multipart request metadata.

idipdName :: Lens' IndexingDatasourcesItemsPoll Text Source #

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

idipdCallback :: Lens' IndexingDatasourcesItemsPoll (Maybe Text) Source #

JSONP