kgsearch  v1
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest Class Reference

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 More...

Inheritance diagram for Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest:
Google.Apis.Kgsearch.v1.KgsearchBaseServiceRequest< Google.Apis.Kgsearch.v1.Data.SearchResponse >

Public Member Functions

 SearchRequest (Google.Apis.Services.IClientService service)
 Constructs a new Search request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes Search parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Kgsearch.v1.KgsearchBaseServiceRequest< Google.Apis.Kgsearch.v1.Data.SearchResponse >
 KgsearchBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new KgsearchBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Kgsearch parameter list. More...
 

Properties

virtual System.Nullable< bool > Prefix [get, set]
 Enables prefix match against names and aliases of entities More...
 
virtual string Query [get, set]
 The literal query string for search. More...
 
virtual Google.Apis.Util.Repeatable< string > Types [get, set]
 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. More...
 
virtual System.Nullable< bool > Indent [get, set]
 Enables indenting of json results. More...
 
virtual Google.Apis.Util.Repeatable< string > Languages [get, set]
 The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. More...
 
virtual Google.Apis.Util.Repeatable< string > Ids [get, set]
 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=B More...
 
virtual System.Nullable< int > Limit [get, set]
 Limits the number of entities to be returned. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Kgsearch.v1.KgsearchBaseServiceRequest< Google.Apis.Kgsearch.v1.Data.SearchResponse >
virtual System.Nullable< XgafvEnum > Xgafv [get, set]
 V1 error format. More...
 
virtual string AccessToken [get, set]
 OAuth access token. More...
 
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for response. More...
 
virtual string Callback [get, set]
 JSONP More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. More...
 
virtual string UploadType [get, set]
 Legacy upload protocol for media (e.g. "media", "multipart"). More...
 
virtual string UploadProtocol [get, set]
 Upload protocol for media (e.g. "raw", "multipart"). More...
 

Detailed 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

Constructor & Destructor Documentation

◆ SearchRequest()

Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.SearchRequest ( Google.Apis.Services.IClientService  service)
inline

Constructs a new Search request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.InitParameters ( )
inlineprotected

Initializes Search parameter list.

Property Documentation

◆ HttpMethod

override string Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.HttpMethod
get

summary>Gets the REST path.

◆ Ids

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Ids
getset

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=B

◆ Indent

virtual System.Nullable<bool> Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Indent
getset

Enables indenting of json results.

◆ Languages

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Languages
getset

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

◆ Limit

virtual System.Nullable<int> Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Limit
getset

Limits the number of entities to be returned.

summary>Gets the method name.

◆ MethodName

override string Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.MethodName
get

summary>Gets the HTTP method.

◆ Prefix

virtual System.Nullable<bool> Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Prefix
getset

Enables prefix match against names and aliases of entities

◆ Query

virtual string Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Query
getset

The literal query string for search.

◆ Types

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Kgsearch.v1.EntitiesResource.SearchRequest.Types
getset

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.


The documentation for this class was generated from the following file: