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.Kgsearch.Entities.Search

Contents

REST Resource
Creating a Request
Request Lenses

Description

Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

See: Knowledge Graph Search API Reference for kgsearch.entities.search.

Synopsis

type EntitiesSearchResource = "v1" :> ("entities:search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "prefix" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "types" Text :> (QueryParams "ids" Text :> (QueryParams "languages" Text :> (QueryParam "indent" Bool :> (QueryParam "query" Text :> (QueryParam "limit" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] SearchResponse))))))))))))))
entitiesSearch :: EntitiesSearch
data EntitiesSearch
esXgafv :: Lens' EntitiesSearch (Maybe Xgafv)
esUploadProtocol :: Lens' EntitiesSearch (Maybe Text)
esPrefix :: Lens' EntitiesSearch (Maybe Bool)
esAccessToken :: Lens' EntitiesSearch (Maybe Text)
esUploadType :: Lens' EntitiesSearch (Maybe Text)
esTypes :: Lens' EntitiesSearch [Text]
esIds :: Lens' EntitiesSearch [Text]
esLanguages :: Lens' EntitiesSearch [Text]
esIndent :: Lens' EntitiesSearch (Maybe Bool)
esQuery :: Lens' EntitiesSearch (Maybe Text)
esLimit :: Lens' EntitiesSearch (Maybe Int32)
esCallback :: Lens' EntitiesSearch (Maybe Text)

REST Resource

A resource alias for kgsearch.entities.search method which the EntitiesSearch request conforms to.

Creating a Request

entitiesSearch :: EntitiesSearch Source #

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

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

data EntitiesSearch Source #

Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

See: entitiesSearch smart constructor.

Instances

Eq EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search Methods (==) :: EntitiesSearch -> EntitiesSearch -> Bool # (/=) :: EntitiesSearch -> EntitiesSearch -> Bool #
Data EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EntitiesSearch -> c EntitiesSearch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EntitiesSearch # toConstr :: EntitiesSearch -> Constr # dataTypeOf :: EntitiesSearch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EntitiesSearch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EntitiesSearch) # gmapT :: (forall b. Data b => b -> b) -> EntitiesSearch -> EntitiesSearch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EntitiesSearch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EntitiesSearch -> r # gmapQ :: (forall d. Data d => d -> u) -> EntitiesSearch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EntitiesSearch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EntitiesSearch -> m EntitiesSearch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EntitiesSearch -> m EntitiesSearch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EntitiesSearch -> m EntitiesSearch #
Show EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search Methods showsPrec :: Int -> EntitiesSearch -> ShowS # show :: EntitiesSearch -> String # showList :: [EntitiesSearch] -> ShowS #
Generic EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search Associated Types type Rep EntitiesSearch :: Type -> Type # Methods from :: EntitiesSearch -> Rep EntitiesSearch x # to :: Rep EntitiesSearch x -> EntitiesSearch #
GoogleRequest EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search Associated Types type Rs EntitiesSearch :: Type # type Scopes EntitiesSearch :: [Symbol] # Methods requestClient :: EntitiesSearch -> GClient (Rs EntitiesSearch) #
type Rep EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search type Rep EntitiesSearch = D1 (MetaData "EntitiesSearch" "Network.Google.Resource.Kgsearch.Entities.Search" "gogol-kgsearch-0.4.0-KXcdVth8YboCjW4HunaolZ" False) (C1 (MetaCons "EntitiesSearch'" PrefixI True) (((S1 (MetaSel (Just "_esXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_esUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_esPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 (MetaSel (Just "_esAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_esUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_esTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 (MetaSel (Just "_esIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_esLanguages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_esIndent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 (MetaSel (Just "_esQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_esLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_esCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search type Scopes EntitiesSearch = ([] :: [Symbol])
type Rs EntitiesSearch Source #
Instance details Defined in Network.Google.Resource.Kgsearch.Entities.Search type Rs EntitiesSearch = SearchResponse

Request Lenses

esXgafv :: Lens' EntitiesSearch (Maybe Xgafv) Source #

V1 error format.

esUploadProtocol :: Lens' EntitiesSearch (Maybe Text) Source #

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

esPrefix :: Lens' EntitiesSearch (Maybe Bool) Source #

Enables prefix match against names and aliases of entities

esAccessToken :: Lens' EntitiesSearch (Maybe Text) Source #

OAuth access token.

esUploadType :: Lens' EntitiesSearch (Maybe Text) Source #

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

esTypes :: Lens' EntitiesSearch [Text] Source #

Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.

esIds :: Lens' EntitiesSearch [Text] Source #

The list of entity id to be used for search instead of query string. To specify multiple ids in the HTTP request, repeat the parameter in the URL as in ...?ids=A&ids=B

esLanguages :: Lens' EntitiesSearch [Text] Source #

The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.

esIndent :: Lens' EntitiesSearch (Maybe Bool) Source #

Enables indenting of json results.

esQuery :: Lens' EntitiesSearch (Maybe Text) Source #

The literal query string for search.

esLimit :: Lens' EntitiesSearch (Maybe Int32) Source #

Limits the number of entities to be returned.

esCallback :: Lens' EntitiesSearch (Maybe Text) Source #

JSONP