com.google.api.services.kgsearch.v1

Class Kgsearch.Entities.Search

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.kgsearch.v1.KgsearchRequest<SearchResponse>

com.google.api.services.kgsearch.v1.Kgsearch.Entities.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Kgsearch.Entities

public class Kgsearch.Entities.Search
extends KgsearchRequest<SearchResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Search() Searches Knowledge Graph for entities that match the constraints.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
List<String>	getIds() The list of entity id to be used for search instead of query string.
Boolean	getIndent() Enables indenting of json results.
List<String>	getLanguages() The list of language codes (defined in ISO 693) to run the query with, e.g.
Integer	getLimit() Limits the number of entities to be returned.
Boolean	getPrefix() Enables prefix match against names and aliases of entities
String	getQuery() The literal query string for search.
List<String>	getTypes() Restricts returned entities with these types, e.g.
Kgsearch.Entities.Search	set(String parameterName, Object value)
Kgsearch.Entities.Search	set$Xgafv(String $Xgafv) V1 error format.
Kgsearch.Entities.Search	setAccessToken(String accessToken) OAuth access token.
Kgsearch.Entities.Search	setAlt(String alt) Data format for response.
Kgsearch.Entities.Search	setCallback(String callback) JSONP
Kgsearch.Entities.Search	setFields(String fields) Selector specifying which fields to include in a partial response.
Kgsearch.Entities.Search	setIds(List<String> ids) The list of entity id to be used for search instead of query string.
Kgsearch.Entities.Search	setIndent(Boolean indent) Enables indenting of json results.
Kgsearch.Entities.Search	setKey(String key) API key.
Kgsearch.Entities.Search	setLanguages(List<String> languages) The list of language codes (defined in ISO 693) to run the query with, e.g.
Kgsearch.Entities.Search	setLimit(Integer limit) Limits the number of entities to be returned.
Kgsearch.Entities.Search	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Kgsearch.Entities.Search	setPrefix(Boolean prefix) Enables prefix match against names and aliases of entities
Kgsearch.Entities.Search	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Kgsearch.Entities.Search	setQuery(String query) The literal query string for search.
Kgsearch.Entities.Search	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Kgsearch.Entities.Search	setTypes(List<String> types) Restricts returned entities with these types, e.g.
Kgsearch.Entities.Search	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Kgsearch.Entities.Search	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.kgsearch.v1.KgsearchRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Search

protected 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 Create a request for the method "entities.search". This request holds the parameters needed by the the kgsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Kgsearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<SearchResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SearchResponse>

Throws:

IOException

set$Xgafv

public Kgsearch.Entities.Search set$Xgafv(String $Xgafv)

Description copied from class: KgsearchRequest

V1 error format.

Overrides:

set$Xgafv in class KgsearchRequest<SearchResponse>

setAccessToken

public Kgsearch.Entities.Search setAccessToken(String accessToken)

Description copied from class: KgsearchRequest

OAuth access token.

Overrides:

setAccessToken in class KgsearchRequest<SearchResponse>

setAlt

public Kgsearch.Entities.Search setAlt(String alt)

Description copied from class: KgsearchRequest

Data format for response.

Overrides:

setAlt in class KgsearchRequest<SearchResponse>

setCallback

public Kgsearch.Entities.Search setCallback(String callback)

Description copied from class: KgsearchRequest

JSONP

Overrides:

setCallback in class KgsearchRequest<SearchResponse>

setFields

public Kgsearch.Entities.Search setFields(String fields)

Description copied from class: KgsearchRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class KgsearchRequest<SearchResponse>

setKey

public Kgsearch.Entities.Search setKey(String key)

Description copied from class: KgsearchRequest

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.

Overrides:

setKey in class KgsearchRequest<SearchResponse>

setOauthToken

public Kgsearch.Entities.Search setOauthToken(String oauthToken)

Description copied from class: KgsearchRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class KgsearchRequest<SearchResponse>

setPrettyPrint

public Kgsearch.Entities.Search setPrettyPrint(Boolean prettyPrint)

Description copied from class: KgsearchRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class KgsearchRequest<SearchResponse>

setQuotaUser

public Kgsearch.Entities.Search setQuotaUser(String quotaUser)

Description copied from class: KgsearchRequest

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.

Overrides:

setQuotaUser in class KgsearchRequest<SearchResponse>

setUploadType

public Kgsearch.Entities.Search setUploadType(String uploadType)

Description copied from class: KgsearchRequest

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

Overrides:

setUploadType in class KgsearchRequest<SearchResponse>

setUploadProtocol

public Kgsearch.Entities.Search setUploadProtocol(String uploadProtocol)

Description copied from class: KgsearchRequest

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

Overrides:

setUploadProtocol in class KgsearchRequest<SearchResponse>

getIds

public List<String> getIds()

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

setIds

public Kgsearch.Entities.Search setIds(List<String> 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=B

getIndent

public Boolean getIndent()

Enables indenting of json results.

setIndent

public Kgsearch.Entities.Search setIndent(Boolean indent)

Enables indenting of json results.

getLanguages

public List<String> getLanguages()

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

setLanguages

public Kgsearch.Entities.Search setLanguages(List<String> languages)

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

getLimit

public Integer getLimit()

Limits the number of entities to be returned.

setLimit

public Kgsearch.Entities.Search setLimit(Integer limit)

Limits the number of entities to be returned.

getPrefix

public Boolean getPrefix()

Enables prefix match against names and aliases of entities

setPrefix

public Kgsearch.Entities.Search setPrefix(Boolean prefix)

Enables prefix match against names and aliases of entities

getQuery

public String getQuery()

The literal query string for search.

setQuery

public Kgsearch.Entities.Search setQuery(String query)

The literal query string for search.

getTypes

public List<String> getTypes()

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.

setTypes

public Kgsearch.Entities.Search setTypes(List<String> 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.

set

public Kgsearch.Entities.Search set(String parameterName,
                                    Object value)

Overrides:

set in class KgsearchRequest<SearchResponse>