Class EntitiesResource.SearchRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchResponse>
KgsearchBaseServiceRequest<SearchResponse>
EntitiesResource.SearchRequest
Implements
Inherited Members
Namespace: Google.Apis.Kgsearch.v1
Assembly: Google.Apis.Kgsearch.v1.dll
Syntax
public class EntitiesResource.SearchRequest : KgsearchBaseServiceRequest<SearchResponse>, IClientServiceRequest<SearchResponse>, IClientServiceRequest

Constructors

SearchRequest(IClientService)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Kgsearch.v1.Data.SearchResponse>.HttpMethod

Ids

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&amp;ids=B

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type Description
Repeatable<string>

Indent

Enables indenting of json results.

Declaration
[RequestParameter("indent", RequestParameterType.Query)]
public virtual bool? Indent { get; set; }
Property Value
Type Description
bool?

Languages

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

Declaration
[RequestParameter("languages", RequestParameterType.Query)]
public virtual Repeatable<string> Languages { get; set; }
Property Value
Type Description
Repeatable<string>

Limit

Limits the number of entities to be returned.

Declaration
[RequestParameter("limit", RequestParameterType.Query)]
public virtual int? Limit { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Kgsearch.v1.Data.SearchResponse>.MethodName

Prefix

Enables prefix match against names and aliases of entities

Declaration
[RequestParameter("prefix", RequestParameterType.Query)]
public virtual bool? Prefix { get; set; }
Property Value
Type Description
bool?

Query

The literal query string for search.

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Kgsearch.v1.Data.SearchResponse>.RestPath

Types

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.

Declaration
[RequestParameter("types", RequestParameterType.Query)]
public virtual Repeatable<string> Types { get; set; }
Property Value
Type Description
Repeatable<string>

Methods

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements