com.google.api.services.customsearch.v1.model

Class Search

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.customsearch.v1.model.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Search
extends com.google.api.client.json.GenericJson

Response to a custom search request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Custom Search API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Search.Queries Query metadata for the previous, current, and next pages of results.
static class	Search.SearchInformation Metadata about a search operation.
static class	Search.Spelling Spell correction information for a query.
static class	Search.Url OpenSearch template and URL.

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

com.google.api.client.util.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>

Constructor Summary

Constructors

Constructor and Description
Search()

Method Summary

Modifier and Type	Method and Description
Search	clone()
Map<String,Object>	getContext() Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query.
List<Result>	getItems() The current set of custom search results.
String	getKind() Unique identifier for the type of current object.
List<Promotion>	getPromotions() The set of [promotions](https://developers.google.com/custom-search/docs/promotions).
Search.Queries	getQueries() Query metadata for the previous, current, and next pages of results.
Search.SearchInformation	getSearchInformation() Metadata about a search operation.
Search.Spelling	getSpelling() Spell correction information for a query.
Search.Url	getUrl() OpenSearch template and URL.
Search	set(String fieldName, Object value)
Search	setContext(Map<String,Object> context) Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query.
Search	setItems(List<Result> items) The current set of custom search results.
Search	setKind(String kind) Unique identifier for the type of current object.
Search	setPromotions(List<Promotion> promotions) The set of [promotions](https://developers.google.com/custom-search/docs/promotions).
Search	setQueries(Search.Queries queries) Query metadata for the previous, current, and next pages of results.
Search	setSearchInformation(Search.SearchInformation searchInformation) Metadata about a search operation.
Search	setSpelling(Search.Spelling spelling) Spell correction information for a query.
Search	setUrl(Search.Url url) OpenSearch template and URL.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

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

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

public Search()

Method Detail

getContext

public Map<String,Object> getContext()

Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.

Returns:

value or null for none

setContext

public Search setContext(Map<String,Object> context)

Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.

Parameters:

context - context or null for none

getItems

public List<Result> getItems()

The current set of custom search results.

Returns:

value or null for none

setItems

public Search setItems(List<Result> items)

The current set of custom search results.

Parameters:

items - items or null for none

getKind

public String getKind()

Unique identifier for the type of current object. For this API, it is customsearch#search.

Returns:

value or null for none

setKind

public Search setKind(String kind)

Unique identifier for the type of current object. For this API, it is customsearch#search.

Parameters:

kind - kind or null for none

getPromotions

public List<Promotion> getPromotions()

The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query.

Returns:

value or null for none

setPromotions

public Search setPromotions(List<Promotion> promotions)

The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query.

Parameters:

promotions - promotions or null for none

getQueries

public Search.Queries getQueries()

Query metadata for the previous, current, and next pages of results.

Returns:

value or null for none

setQueries

public Search setQueries(Search.Queries queries)

Query metadata for the previous, current, and next pages of results.

Parameters:

queries - queries or null for none

getSearchInformation

public Search.SearchInformation getSearchInformation()

Metadata about a search operation.

Returns:

value or null for none

setSearchInformation

public Search setSearchInformation(Search.SearchInformation searchInformation)

Metadata about a search operation.

Parameters:

searchInformation - searchInformation or null for none

getSpelling

public Search.Spelling getSpelling()

Spell correction information for a query.

Returns:

value or null for none

setSpelling

public Search setSpelling(Search.Spelling spelling)

Spell correction information for a query.

Parameters:

spelling - spelling or null for none

getUrl

public Search.Url getUrl()

OpenSearch template and URL.

Returns:

value or null for none

setUrl

public Search setUrl(Search.Url url)

OpenSearch template and URL.

Parameters:

url - url or null for none

set

public Search set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Search clone()

Overrides:

clone in class com.google.api.client.json.GenericJson