public class Customsearch.Cse.List extends CustomsearchRequest<Search>
com.google.api.client.util.GenericData.Flags| Modifier | Constructor and Description |
|---|---|
protected |
List()
Returns metadata about the search performed, metadata about the custom search engine used for
the search, and the search results.
|
| Modifier and Type | Method and Description |
|---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
java.lang.String |
getC2coff()
Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com
/custom-search/docs/xml_results#chineseSearch).
|
java.lang.String |
getCr()
Restricts search results to documents originating in a particular country.
|
java.lang.String |
getCx()
The custom search engine ID to use for this request.
|
java.lang.String |
getDateRestrict()
Restricts results to URLs based on date.
|
java.lang.String |
getExactTerms()
Identifies a phrase that all documents in the search results must contain.
|
java.lang.String |
getExcludeTerms()
Identifies a word or phrase that should not appear in any documents in the search results.
|
java.lang.String |
getFileType()
Restricts results to files of a specified extension.
|
java.lang.String |
getFilter()
Controls turning on or off the duplicate content filter.
|
java.lang.String |
getGl()
Geolocation of end user.
|
java.lang.String |
getGooglehost()
Deprecated**.
|
java.lang.String |
getHighRange()
Specifies the ending value for a search range.
|
java.lang.String |
getHl()
Sets the user interface language.
|
java.lang.String |
getHq()
Appends the specified query terms to the query, as if they were combined with a logical AND
operator.
|
java.lang.String |
getImgColorType()
Returns black and white, grayscale, transparent, or color images.
|
java.lang.String |
getImgDominantColor()
Returns images of a specific dominant color.
|
java.lang.String |
getImgSize()
Returns images of a specified size.
|
java.lang.String |
getImgType()
Returns images of a type.
|
java.lang.String |
getLinkSite()
Specifies that all search results should contain a link to a particular URL.
|
java.lang.String |
getLowRange()
Specifies the starting value for a search range.
|
java.lang.String |
getLr()
Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`).
|
java.lang.Integer |
getNum()
Number of search results to return.
|
java.lang.String |
getOrTerms()
Provides additional search terms to check for in a document, where each document in the search
results must contain at least one of the additional search terms.
|
java.lang.String |
getQ()
Query
|
java.lang.String |
getRelatedSite()
Specifies that all search results should be pages that are related to the specified URL.
|
java.lang.String |
getRights()
Filters based on licensing.
|
java.lang.String |
getSafe()
Search safety level.
|
java.lang.String |
getSearchType()
Specifies the search type: `image`.
|
java.lang.String |
getSiteSearch()
Specifies a given site which should always be included or excluded from results (see
`siteSearchFilter` parameter, below).
|
java.lang.String |
getSiteSearchFilter()
Controls whether to include or exclude results from the site named in the `siteSearch` parameter.
|
java.lang.String |
getSort()
The sort expression to apply to the results.
|
java.lang.Long |
getStart()
The index of the first result to return.
|
Customsearch.Cse.List |
set(java.lang.String parameterName,
java.lang.Object value) |
Customsearch.Cse.List |
set$Xgafv(java.lang.String $Xgafv)
V1 error format.
|
Customsearch.Cse.List |
setAccessToken(java.lang.String accessToken)
OAuth access token.
|
Customsearch.Cse.List |
setAlt(java.lang.String alt)
Data format for response.
|
Customsearch.Cse.List |
setC2coff(java.lang.String c2coff)
Enables or disables [Simplified and Traditional Chinese
Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).
|
Customsearch.Cse.List |
setCallback(java.lang.String callback)
JSONP
|
Customsearch.Cse.List |
setCr(java.lang.String cr)
Restricts search results to documents originating in a particular country.
|
Customsearch.Cse.List |
setCx(java.lang.String cx)
The custom search engine ID to use for this request.
|
Customsearch.Cse.List |
setDateRestrict(java.lang.String dateRestrict)
Restricts results to URLs based on date.
|
Customsearch.Cse.List |
setExactTerms(java.lang.String exactTerms)
Identifies a phrase that all documents in the search results must contain.
|
Customsearch.Cse.List |
setExcludeTerms(java.lang.String excludeTerms)
Identifies a word or phrase that should not appear in any documents in the search results.
|
Customsearch.Cse.List |
setFields(java.lang.String fields)
Selector specifying which fields to include in a partial response.
|
Customsearch.Cse.List |
setFileType(java.lang.String fileType)
Restricts results to files of a specified extension.
|
Customsearch.Cse.List |
setFilter(java.lang.String filter)
Controls turning on or off the duplicate content filter.
|
Customsearch.Cse.List |
setGl(java.lang.String gl)
Geolocation of end user.
|
Customsearch.Cse.List |
setGooglehost(java.lang.String googlehost)
**Deprecated**.
|
Customsearch.Cse.List |
setHighRange(java.lang.String highRange)
Specifies the ending value for a search range.
|
Customsearch.Cse.List |
setHl(java.lang.String hl)
Sets the user interface language.
|
Customsearch.Cse.List |
setHq(java.lang.String hq)
Appends the specified query terms to the query, as if they were combined with a logical AND
operator.
|
Customsearch.Cse.List |
setImgColorType(java.lang.String imgColorType)
Returns black and white, grayscale, transparent, or color images.
|
Customsearch.Cse.List |
setImgDominantColor(java.lang.String imgDominantColor)
Returns images of a specific dominant color.
|
Customsearch.Cse.List |
setImgSize(java.lang.String imgSize)
Returns images of a specified size.
|
Customsearch.Cse.List |
setImgType(java.lang.String imgType)
Returns images of a type.
|
Customsearch.Cse.List |
setKey(java.lang.String key)
API key.
|
Customsearch.Cse.List |
setLinkSite(java.lang.String linkSite)
Specifies that all search results should contain a link to a particular URL.
|
Customsearch.Cse.List |
setLowRange(java.lang.String lowRange)
Specifies the starting value for a search range.
|
Customsearch.Cse.List |
setLr(java.lang.String lr)
Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`).
|
Customsearch.Cse.List |
setNum(java.lang.Integer num)
Number of search results to return.
|
Customsearch.Cse.List |
setOauthToken(java.lang.String oauthToken)
OAuth 2.0 token for the current user.
|
Customsearch.Cse.List |
setOrTerms(java.lang.String orTerms)
Provides additional search terms to check for in a document, where each document in the
search results must contain at least one of the additional search terms.
|
Customsearch.Cse.List |
setPrettyPrint(java.lang.Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Customsearch.Cse.List |
setQ(java.lang.String q)
Query
|
Customsearch.Cse.List |
setQuotaUser(java.lang.String quotaUser)
Available to use for quota purposes for server-side applications.
|
Customsearch.Cse.List |
setRelatedSite(java.lang.String relatedSite)
Specifies that all search results should be pages that are related to the specified URL.
|
Customsearch.Cse.List |
setRights(java.lang.String rights)
Filters based on licensing.
|
Customsearch.Cse.List |
setSafe(java.lang.String safe)
Search safety level.
|
Customsearch.Cse.List |
setSearchType(java.lang.String searchType)
Specifies the search type: `image`.
|
Customsearch.Cse.List |
setSiteSearch(java.lang.String siteSearch)
Specifies a given site which should always be included or excluded from results (see
`siteSearchFilter` parameter, below).
|
Customsearch.Cse.List |
setSiteSearchFilter(java.lang.String siteSearchFilter)
Controls whether to include or exclude results from the site named in the `siteSearch`
parameter.
|
Customsearch.Cse.List |
setSort(java.lang.String sort)
The sort expression to apply to the results.
|
Customsearch.Cse.List |
setStart(java.lang.Long start)
The index of the first result to return.
|
Customsearch.Cse.List |
setUploadProtocol(java.lang.String uploadProtocol)
Upload protocol for media (e.g.
|
Customsearch.Cse.List |
setUploadType(java.lang.String uploadType)
Legacy upload protocol for media (e.g.
|
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeadersgetJsonContent, newExceptionOnError, queuebuildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queueclone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeysclear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, valuesprotected List()
AbstractGoogleClientRequest.execute() method to invoke the remote operation.
Customsearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be called to initialize this instance immediately after invoking the constructor.
public com.google.api.client.http.HttpResponse executeUsingHead()
throws java.io.IOException
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Search>java.io.IOExceptionpublic com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws java.io.IOException
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Search>java.io.IOExceptionpublic Customsearch.Cse.List set$Xgafv(java.lang.String $Xgafv)
CustomsearchRequestset$Xgafv in class CustomsearchRequest<Search>public Customsearch.Cse.List setAccessToken(java.lang.String accessToken)
CustomsearchRequestsetAccessToken in class CustomsearchRequest<Search>public Customsearch.Cse.List setAlt(java.lang.String alt)
CustomsearchRequestsetAlt in class CustomsearchRequest<Search>public Customsearch.Cse.List setCallback(java.lang.String callback)
CustomsearchRequestsetCallback in class CustomsearchRequest<Search>public Customsearch.Cse.List setFields(java.lang.String fields)
CustomsearchRequestsetFields in class CustomsearchRequest<Search>public Customsearch.Cse.List setKey(java.lang.String key)
CustomsearchRequestsetKey in class CustomsearchRequest<Search>public Customsearch.Cse.List setOauthToken(java.lang.String oauthToken)
CustomsearchRequestsetOauthToken in class CustomsearchRequest<Search>public Customsearch.Cse.List setPrettyPrint(java.lang.Boolean prettyPrint)
CustomsearchRequestsetPrettyPrint in class CustomsearchRequest<Search>public Customsearch.Cse.List setQuotaUser(java.lang.String quotaUser)
CustomsearchRequestsetQuotaUser in class CustomsearchRequest<Search>public Customsearch.Cse.List setUploadType(java.lang.String uploadType)
CustomsearchRequestsetUploadType in class CustomsearchRequest<Search>public Customsearch.Cse.List setUploadProtocol(java.lang.String uploadProtocol)
CustomsearchRequestsetUploadProtocol in class CustomsearchRequest<Search>public java.lang.String getCx()
public Customsearch.Cse.List setCx(java.lang.String cx)
public java.lang.Long getStart()
public Customsearch.Cse.List setStart(java.lang.Long start)
public java.lang.String getImgColorType()
public Customsearch.Cse.List setImgColorType(java.lang.String imgColorType)
public java.lang.String getFileType()
public Customsearch.Cse.List setFileType(java.lang.String fileType)
public java.lang.String getCr()
public Customsearch.Cse.List setCr(java.lang.String cr)
public java.lang.String getSafe()
public Customsearch.Cse.List setSafe(java.lang.String safe)
public java.lang.String getExcludeTerms()
public Customsearch.Cse.List setExcludeTerms(java.lang.String excludeTerms)
public java.lang.String getOrTerms()
public Customsearch.Cse.List setOrTerms(java.lang.String orTerms)
public java.lang.String getSiteSearch()
public Customsearch.Cse.List setSiteSearch(java.lang.String siteSearch)
public java.lang.String getLinkSite()
public Customsearch.Cse.List setLinkSite(java.lang.String linkSite)
public java.lang.String getQ()
public Customsearch.Cse.List setQ(java.lang.String q)
public java.lang.String getHl()
public Customsearch.Cse.List setHl(java.lang.String hl)
public java.lang.String getFilter()
public Customsearch.Cse.List setFilter(java.lang.String filter)
public java.lang.String getC2coff()
public Customsearch.Cse.List setC2coff(java.lang.String c2coff)
public java.lang.String getGl()
public Customsearch.Cse.List setGl(java.lang.String gl)
public java.lang.String getDateRestrict()
public Customsearch.Cse.List setDateRestrict(java.lang.String dateRestrict)
public java.lang.String getImgDominantColor()
public Customsearch.Cse.List setImgDominantColor(java.lang.String imgDominantColor)
public java.lang.String getRights()
public Customsearch.Cse.List setRights(java.lang.String rights)
public java.lang.String getImgSize()
public Customsearch.Cse.List setImgSize(java.lang.String imgSize)
public java.lang.String getImgType()
public Customsearch.Cse.List setImgType(java.lang.String imgType)
public java.lang.Integer getNum()
public Customsearch.Cse.List setNum(java.lang.Integer num)
public java.lang.String getGooglehost()
public Customsearch.Cse.List setGooglehost(java.lang.String googlehost)
public java.lang.String getHighRange()
public Customsearch.Cse.List setHighRange(java.lang.String highRange)
public java.lang.String getExactTerms()
public Customsearch.Cse.List setExactTerms(java.lang.String exactTerms)
public java.lang.String getSearchType()
public Customsearch.Cse.List setSearchType(java.lang.String searchType)
public java.lang.String getHq()
public Customsearch.Cse.List setHq(java.lang.String hq)
public java.lang.String getRelatedSite()
public Customsearch.Cse.List setRelatedSite(java.lang.String relatedSite)
public java.lang.String getSort()
public Customsearch.Cse.List setSort(java.lang.String sort)
public java.lang.String getLr()
public Customsearch.Cse.List setLr(java.lang.String lr)
public java.lang.String getSiteSearchFilter()
public Customsearch.Cse.List setSiteSearchFilter(java.lang.String siteSearchFilter)
public java.lang.String getLowRange()
public Customsearch.Cse.List setLowRange(java.lang.String lowRange)
public Customsearch.Cse.List set(java.lang.String parameterName, java.lang.Object value)
set in class CustomsearchRequest<Search>