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.Query.Search

Contents

REST Resource
Creating a Request
Request Lenses

Description

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party.

See: Cloud Search API Reference for cloudsearch.query.search.

Synopsis

type QuerySearchResource = "v1" :> ("query" :> ("search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SearchRequest :> Post '[JSON] SearchResponse)))))))))
querySearch :: SearchRequest -> QuerySearch
data QuerySearch
qXgafv :: Lens' QuerySearch (Maybe Xgafv)
qUploadProtocol :: Lens' QuerySearch (Maybe Text)
qAccessToken :: Lens' QuerySearch (Maybe Text)
qUploadType :: Lens' QuerySearch (Maybe Text)
qPayload :: Lens' QuerySearch SearchRequest
qCallback :: Lens' QuerySearch (Maybe Text)

REST Resource

type QuerySearchResource = "v1" :> ("query" :> ("search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SearchRequest :> Post '[JSON] SearchResponse))))))))) Source #

A resource alias for cloudsearch.query.search method which the QuerySearch request conforms to.

Creating a Request

querySearch Source #

Arguments

:: SearchRequest	`qPayload`
-> QuerySearch

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

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

data QuerySearch Source #

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party.

See: querySearch smart constructor.

Instances

Eq QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search Methods (==) :: QuerySearch -> QuerySearch -> Bool # (/=) :: QuerySearch -> QuerySearch -> Bool #
Data QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QuerySearch -> c QuerySearch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QuerySearch # toConstr :: QuerySearch -> Constr # dataTypeOf :: QuerySearch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c QuerySearch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QuerySearch) # gmapT :: (forall b. Data b => b -> b) -> QuerySearch -> QuerySearch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QuerySearch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QuerySearch -> r # gmapQ :: (forall d. Data d => d -> u) -> QuerySearch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QuerySearch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QuerySearch -> m QuerySearch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QuerySearch -> m QuerySearch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QuerySearch -> m QuerySearch #
Show QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search Methods showsPrec :: Int -> QuerySearch -> ShowS # show :: QuerySearch -> String # showList :: [QuerySearch] -> ShowS #
Generic QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search Associated Types type Rep QuerySearch :: Type -> Type # Methods from :: QuerySearch -> Rep QuerySearch x # to :: Rep QuerySearch x -> QuerySearch #
GoogleRequest QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search Associated Types type Rs QuerySearch :: Type # type Scopes QuerySearch :: [Symbol] # Methods requestClient :: QuerySearch -> GClient (Rs QuerySearch) #
type Rep QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search type Rep QuerySearch = D1 (MetaData "QuerySearch" "Network.Google.Resource.CloudSearch.Query.Search" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "QuerySearch'" PrefixI True) ((S1 (MetaSel (Just "_qXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_qUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_qAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_qUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_qPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SearchRequest) :*: S1 (MetaSel (Just "_qCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search type Scopes QuerySearch = "https://www.googleapis.com/auth/cloud_search" ': ("https://www.googleapis.com/auth/cloud_search.query" ': ([] :: [Symbol]))
type Rs QuerySearch Source #
Instance details Defined in Network.Google.Resource.CloudSearch.Query.Search type Rs QuerySearch = SearchResponse

Request Lenses

qXgafv :: Lens' QuerySearch (Maybe Xgafv) Source #

V1 error format.

qUploadProtocol :: Lens' QuerySearch (Maybe Text) Source #

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

qAccessToken :: Lens' QuerySearch (Maybe Text) Source #

OAuth access token.

qUploadType :: Lens' QuerySearch (Maybe Text) Source #

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

qPayload :: Lens' QuerySearch SearchRequest Source #

Multipart request metadata.

qCallback :: Lens' QuerySearch (Maybe Text) Source #

JSONP