Network.Google.Resource.Kgsearch.Entities.Search

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.

REST Resource

type EntitiesSearchResource = "v1" :> ("entities:search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "prefix" Bool :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "types" Text :> (QueryParams "ids" Text :> (QueryParams "languages" Text :> (QueryParam "indent" Bool :> (QueryParam "bearer_token" Text :> (QueryParam "query" Text :> (QueryParam "limit" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] SearchResponse))))))))))))))))

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

Creating a Request

entitiesSearch :: EntitiesSearch

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:

• esXgafv
• esUploadProtocol
• esPrefix
• esPp
• esAccessToken
• esUploadType
• esTypes
• esIds
• esLanguages
• esIndent
• esBearerToken
• esQuery
• esLimit
• esCallback

data EntitiesSearch

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

Methods

(==) :: EntitiesSearch -> EntitiesSearch -> Bool

(/=) :: EntitiesSearch -> EntitiesSearch -> Bool

Data EntitiesSearch

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

Methods

showsPrec :: Int -> EntitiesSearch -> ShowS

show :: EntitiesSearch -> String

showList :: [EntitiesSearch] -> ShowS

Generic EntitiesSearch

Associated Types

type Rep EntitiesSearch :: * -> *

Methods

from :: EntitiesSearch -> Rep EntitiesSearch x

to :: Rep EntitiesSearch x -> EntitiesSearch

GoogleRequest EntitiesSearch

Associated Types

type Rs EntitiesSearch :: *

type Scopes EntitiesSearch :: [Symbol]

Methods

requestClient :: EntitiesSearch -> Client (Rs EntitiesSearch)

type Rep EntitiesSearch

type Rep EntitiesSearch = D1 (MetaData "EntitiesSearch" "Network.Google.Resource.Kgsearch.Entities.Search" "gogol-kgsearch-0.3.0-8wYqlbIgh8v1gL5Xhihoys" False) (C1 (MetaCons "EntitiesSearch'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_esXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) ((:*:) (S1 (MetaSel (Just Symbol "_esUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_esPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_esPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_esAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_esUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_esTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_esIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_esLanguages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_esIndent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_esBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_esQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_esLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_esCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes EntitiesSearch

type Scopes EntitiesSearch = [] Symbol

type Rs EntitiesSearch

type Rs EntitiesSearch = SearchResponse

Request Lenses

esXgafv :: Lens' EntitiesSearch (Maybe Xgafv)

V1 error format.

esUploadProtocol :: Lens' EntitiesSearch (Maybe Text)

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

esPrefix :: Lens' EntitiesSearch (Maybe Bool)

Enables prefix match against names and aliases of entities

esPp :: Lens' EntitiesSearch Bool

Pretty-print response.

esAccessToken :: Lens' EntitiesSearch (Maybe Text)

OAuth access token.

esUploadType :: Lens' EntitiesSearch (Maybe Text)

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

esTypes :: Lens' EntitiesSearch [Text]

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]

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]

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

esIndent :: Lens' EntitiesSearch (Maybe Bool)

Enables indenting of json results.

esBearerToken :: Lens' EntitiesSearch (Maybe Text)

OAuth bearer token.

esQuery :: Lens' EntitiesSearch (Maybe Text)

The literal query string for search.

esLimit :: Lens' EntitiesSearch (Maybe Int32)

Limits the number of entities to be returned.

esCallback :: Lens' EntitiesSearch (Maybe Text)

JSONP