CustomSearchAPI.Cse.Siterestrict.List (Custom Search API v1-rev20240821-2.0.0)

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.customsearch.v1.CustomSearchAPIRequest<Search>
        
        com.google.api.services.customsearch.v1.CustomSearchAPI.Cse.Siterestrict.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CustomSearchAPI.Cse.Siterestrict
```
public class CustomSearchAPI.Cse.Siterestrict.List
extends CustomSearchAPIRequest<Search>
```

Nested Class Summary
- 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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List()
Returns metadata about the search performed, metadata about the engine used for the search, and the search results.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Returns metadata about the search performed, metadata about the engine used for the search, and the search results.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getC2coff()` Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch).
`String`	`getCr()` Restricts search results to documents originating in a particular country.
`String`	`getCx()` The Programmable Search Engine ID to use for this request.
`String`	`getDateRestrict()` Restricts results to URLs based on date.
`Boolean`	`getEnableAlternateSearchHandler()` Optional.
`String`	`getExactTerms()` Identifies a phrase that all documents in the search results must contain.
`String`	`getExcludeTerms()` Identifies a word or phrase that should not appear in any documents in the search results.
`String`	`getFileType()` Restricts results to files of a specified extension.
`String`	`getFilter()` Controls turning on or off the duplicate content filter.
`String`	`getGl()` Geolocation of end user.
`String`	`getGooglehost()` Deprecated**.
`String`	`getHighRange()` Specifies the ending value for a search range.
`String`	`getHl()` Sets the user interface language.
`String`	`getHq()` Appends the specified query terms to the query, as if they were combined with a logical AND operator.
`String`	`getImgColorType()` Returns black and white, grayscale, transparent, or color images.
`String`	`getImgDominantColor()` Returns images of a specific dominant color.
`String`	`getImgSize()` Returns images of a specified size.
`String`	`getImgType()` Returns images of a type.
`String`	`getLinkSite()` Specifies that all search results should contain a link to a particular URL.
`String`	`getLowRange()` Specifies the starting value for a search range.
`String`	`getLr()` Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`).
`Integer`	`getNum()` Number of search results to return.
`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.
`String`	`getQ()` Query
`String`	`getRelatedSite()` Deprecated.
`String`	`getRights()` Filters based on licensing.
`String`	`getSafe()` Search safety level.
`String`	`getSearchType()` Specifies the search type: `image`.
`String`	`getSiteSearch()` Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).
`String`	`getSiteSearchFilter()` Controls whether to include or exclude results from the site named in the `siteSearch` parameter.
`Integer`	`getSnippetLength()` Optional.
`String`	`getSort()` The sort expression to apply to the results.
`Long`	`getStart()` The index of the first result to return.
`CustomSearchAPI.Cse.Siterestrict.List`	`set(String parameterName, Object value)`
`CustomSearchAPI.Cse.Siterestrict.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`CustomSearchAPI.Cse.Siterestrict.List`	`setAccessToken(String accessToken)` OAuth access token.
`CustomSearchAPI.Cse.Siterestrict.List`	`setAlt(String alt)` Data format for response.
`CustomSearchAPI.Cse.Siterestrict.List`	`setC2coff(String c2coff)` Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom- search/docs/json_api_reference#chineseSearch).
`CustomSearchAPI.Cse.Siterestrict.List`	`setCallback(String callback)` JSONP
`CustomSearchAPI.Cse.Siterestrict.List`	`setCr(String cr)` Restricts search results to documents originating in a particular country.
`CustomSearchAPI.Cse.Siterestrict.List`	`setCx(String cx)` The Programmable Search Engine ID to use for this request.
`CustomSearchAPI.Cse.Siterestrict.List`	`setDateRestrict(String dateRestrict)` Restricts results to URLs based on date.
`CustomSearchAPI.Cse.Siterestrict.List`	`setEnableAlternateSearchHandler(Boolean enableAlternateSearchHandler)` Optional.
`CustomSearchAPI.Cse.Siterestrict.List`	`setExactTerms(String exactTerms)` Identifies a phrase that all documents in the search results must contain.
`CustomSearchAPI.Cse.Siterestrict.List`	`setExcludeTerms(String excludeTerms)` Identifies a word or phrase that should not appear in any documents in the search results.
`CustomSearchAPI.Cse.Siterestrict.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CustomSearchAPI.Cse.Siterestrict.List`	`setFileType(String fileType)` Restricts results to files of a specified extension.
`CustomSearchAPI.Cse.Siterestrict.List`	`setFilter(String filter)` Controls turning on or off the duplicate content filter.
`CustomSearchAPI.Cse.Siterestrict.List`	`setGl(String gl)` Geolocation of end user.
`CustomSearchAPI.Cse.Siterestrict.List`	`setGooglehost(String googlehost)` Deprecated.
`CustomSearchAPI.Cse.Siterestrict.List`	`setHighRange(String highRange)` Specifies the ending value for a search range.
`CustomSearchAPI.Cse.Siterestrict.List`	`setHl(String hl)` Sets the user interface language.
`CustomSearchAPI.Cse.Siterestrict.List`	`setHq(String hq)` Appends the specified query terms to the query, as if they were combined with a logical AND operator.
`CustomSearchAPI.Cse.Siterestrict.List`	`setImgColorType(String imgColorType)` Returns black and white, grayscale, transparent, or color images.
`CustomSearchAPI.Cse.Siterestrict.List`	`setImgDominantColor(String imgDominantColor)` Returns images of a specific dominant color.
`CustomSearchAPI.Cse.Siterestrict.List`	`setImgSize(String imgSize)` Returns images of a specified size.
`CustomSearchAPI.Cse.Siterestrict.List`	`setImgType(String imgType)` Returns images of a type.
`CustomSearchAPI.Cse.Siterestrict.List`	`setKey(String key)` API key.
`CustomSearchAPI.Cse.Siterestrict.List`	`setLinkSite(String linkSite)` Specifies that all search results should contain a link to a particular URL.
`CustomSearchAPI.Cse.Siterestrict.List`	`setLowRange(String lowRange)` Specifies the starting value for a search range.
`CustomSearchAPI.Cse.Siterestrict.List`	`setLr(String lr)` Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`).
`CustomSearchAPI.Cse.Siterestrict.List`	`setNum(Integer num)` Number of search results to return.
`CustomSearchAPI.Cse.Siterestrict.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CustomSearchAPI.Cse.Siterestrict.List`	`setOrTerms(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.
`CustomSearchAPI.Cse.Siterestrict.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CustomSearchAPI.Cse.Siterestrict.List`	`setQ(String q)` Query
`CustomSearchAPI.Cse.Siterestrict.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CustomSearchAPI.Cse.Siterestrict.List`	`setRelatedSite(String relatedSite)` Deprecated.
`CustomSearchAPI.Cse.Siterestrict.List`	`setRights(String rights)` Filters based on licensing.
`CustomSearchAPI.Cse.Siterestrict.List`	`setSafe(String safe)` Search safety level.
`CustomSearchAPI.Cse.Siterestrict.List`	`setSearchType(String searchType)` Specifies the search type: `image`.
`CustomSearchAPI.Cse.Siterestrict.List`	`setSiteSearch(String siteSearch)` Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).
`CustomSearchAPI.Cse.Siterestrict.List`	`setSiteSearchFilter(String siteSearchFilter)` Controls whether to include or exclude results from the site named in the `siteSearch` parameter.
`CustomSearchAPI.Cse.Siterestrict.List`	`setSnippetLength(Integer snippetLength)` Optional.
`CustomSearchAPI.Cse.Siterestrict.List`	`setSort(String sort)` The sort expression to apply to the results.
`CustomSearchAPI.Cse.Siterestrict.List`	`setStart(Long start)` The index of the first result to return.
`CustomSearchAPI.Cse.Siterestrict.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CustomSearchAPI.Cse.Siterestrict.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.customsearch.v1.CustomSearchAPIRequest
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
  - List
```
protected List()
```
    Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns. Create a request for the method "siterestrict.list". This request holds the parameters needed by the the customsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CustomSearchAPI.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 com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Search>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Search>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CustomSearchAPI.Cse.Siterestrict.List set$Xgafv(String $Xgafv)
```
    Description copied from class: CustomSearchAPIRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CustomSearchAPIRequest<Search>
  - setAccessToken
```
public CustomSearchAPI.Cse.Siterestrict.List setAccessToken(String accessToken)
```
    Description copied from class: CustomSearchAPIRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CustomSearchAPIRequest<Search>
  - setAlt
```
public CustomSearchAPI.Cse.Siterestrict.List setAlt(String alt)
```
    Description copied from class: CustomSearchAPIRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CustomSearchAPIRequest<Search>
  - setCallback
```
public CustomSearchAPI.Cse.Siterestrict.List setCallback(String callback)
```
    Description copied from class: CustomSearchAPIRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CustomSearchAPIRequest<Search>
  - setFields
```
public CustomSearchAPI.Cse.Siterestrict.List setFields(String fields)
```
    Description copied from class: CustomSearchAPIRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CustomSearchAPIRequest<Search>
  - setKey
```
public CustomSearchAPI.Cse.Siterestrict.List setKey(String key)
```
    Description copied from class: CustomSearchAPIRequest
    
    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 CustomSearchAPIRequest<Search>
  - setOauthToken
```
public CustomSearchAPI.Cse.Siterestrict.List setOauthToken(String oauthToken)
```
    Description copied from class: CustomSearchAPIRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CustomSearchAPIRequest<Search>
  - setPrettyPrint
```
public CustomSearchAPI.Cse.Siterestrict.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CustomSearchAPIRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CustomSearchAPIRequest<Search>
  - setQuotaUser
```
public CustomSearchAPI.Cse.Siterestrict.List setQuotaUser(String quotaUser)
```
    Description copied from class: CustomSearchAPIRequest
    
    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 CustomSearchAPIRequest<Search>
  - setUploadType
```
public CustomSearchAPI.Cse.Siterestrict.List setUploadType(String uploadType)
```
    Description copied from class: CustomSearchAPIRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CustomSearchAPIRequest<Search>
  - setUploadProtocol
```
public CustomSearchAPI.Cse.Siterestrict.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CustomSearchAPIRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CustomSearchAPIRequest<Search>
  - getC2coff
```
public String getC2coff()
```
    Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
  - setC2coff
```
public CustomSearchAPI.Cse.Siterestrict.List setC2coff(String c2coff)
```
    Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom- search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
  - getCr
```
public String getCr()
```
    Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom- search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.
  - setCr
```
public CustomSearchAPI.Cse.Siterestrict.List setCr(String cr)
```
    Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom- search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom- search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.
  - getCx
```
public String getCx()
```
    The Programmable Search Engine ID to use for this request.
  - setCx
```
public CustomSearchAPI.Cse.Siterestrict.List setCx(String cx)
```
    The Programmable Search Engine ID to use for this request.
  - getDateRestrict
```
public String getDateRestrict()
```
    Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
  - setDateRestrict
```
public CustomSearchAPI.Cse.Siterestrict.List setDateRestrict(String dateRestrict)
```
    Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
  - getEnableAlternateSearchHandler
```
public Boolean getEnableAlternateSearchHandler()
```
    Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.
  - setEnableAlternateSearchHandler
```
public CustomSearchAPI.Cse.Siterestrict.List setEnableAlternateSearchHandler(Boolean enableAlternateSearchHandler)
```
    Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.
  - getExactTerms
```
public String getExactTerms()
```
    Identifies a phrase that all documents in the search results must contain.
  - setExactTerms
```
public CustomSearchAPI.Cse.Siterestrict.List setExactTerms(String exactTerms)
```
    Identifies a phrase that all documents in the search results must contain.
  - getExcludeTerms
```
public String getExcludeTerms()
```
    Identifies a word or phrase that should not appear in any documents in the search results.
  - setExcludeTerms
```
public CustomSearchAPI.Cse.Siterestrict.List setExcludeTerms(String excludeTerms)
```
    Identifies a word or phrase that should not appear in any documents in the search results.
  - getFileType
```
public String getFileType()
```
    Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).
  - setFileType
```
public CustomSearchAPI.Cse.Siterestrict.List setFileType(String fileType)
```
    Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).
  - getFilter
```
public String getFilter()
```
    Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.
  - setFilter
```
public CustomSearchAPI.Cse.Siterestrict.List setFilter(String filter)
```
    Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom- search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.
  - getGl
```
public String getGl()
```
    Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.
  - setGl
```
public CustomSearchAPI.Cse.Siterestrict.List setGl(String gl)
```
    Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom- search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.
  - getGooglehost
```
public String getGooglehost()
```
    Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.
  - setGooglehost
```
public CustomSearchAPI.Cse.Siterestrict.List setGooglehost(String googlehost)
```
    **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.
  - getHighRange
```
public String getHighRange()
```
    Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.
  - setHighRange
```
public CustomSearchAPI.Cse.Siterestrict.List setHighRange(String highRange)
```
    Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.
  - getHl
```
public String getHl()
```
    Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom- search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom- search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
  - setHl
```
public CustomSearchAPI.Cse.Siterestrict.List setHl(String hl)
```
    Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom- search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom- search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom- search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
  - getHq
```
public String getHq()
```
    Appends the specified query terms to the query, as if they were combined with a logical AND operator.
  - setHq
```
public CustomSearchAPI.Cse.Siterestrict.List setHq(String hq)
```
    Appends the specified query terms to the query, as if they were combined with a logical AND operator.
  - getImgColorType
```
public String getImgColorType()
```
    Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background
  - setImgColorType
```
public CustomSearchAPI.Cse.Siterestrict.List setImgColorType(String imgColorType)
```
    Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background
  - getImgDominantColor
```
public String getImgDominantColor()
```
    Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"`
  - setImgDominantColor
```
public CustomSearchAPI.Cse.Siterestrict.List setImgDominantColor(String imgDominantColor)
```
    Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"`
  - getImgSize
```
public String getImgSize()
```
    Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"`
  - setImgSize
```
public CustomSearchAPI.Cse.Siterestrict.List setImgSize(String imgSize)
```
    Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"`
  - getImgType
```
public String getImgType()
```
    Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` `"photo"` * `"animated"`
  - setImgType
```
public CustomSearchAPI.Cse.Siterestrict.List setImgType(String imgType)
```
    Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"`
  - getLinkSite
```
public String getLinkSite()
```
    Specifies that all search results should contain a link to a particular URL.
  - setLinkSite
```
public CustomSearchAPI.Cse.Siterestrict.List setLinkSite(String linkSite)
```
    Specifies that all search results should contain a link to a particular URL.
  - getLowRange
```
public String getLowRange()
```
    Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.
  - setLowRange
```
public CustomSearchAPI.Cse.Siterestrict.List setLowRange(String lowRange)
```
    Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.
  - getLr
```
public String getLr()
```
    Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)
  - setLr
```
public CustomSearchAPI.Cse.Siterestrict.List setLr(String lr)
```
    Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)
  - getNum
```
public Integer getNum()
```
    Number of search results to return. * Valid values are integers between 1 and 10, inclusive.
  - setNum
```
public CustomSearchAPI.Cse.Siterestrict.List setNum(Integer num)
```
    Number of search results to return. * Valid values are integers between 1 and 10, inclusive.
  - getOrTerms
```
public 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.
  - setOrTerms
```
public CustomSearchAPI.Cse.Siterestrict.List setOrTerms(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.
  - getQ
```
public String getQ()
```
    Query
  - setQ
```
public CustomSearchAPI.Cse.Siterestrict.List setQ(String q)
```
    Query
  - getRelatedSite
```
public String getRelatedSite()
```
    Deprecated.
  - setRelatedSite
```
public CustomSearchAPI.Cse.Siterestrict.List setRelatedSite(String relatedSite)
```
    Deprecated.
  - getRights
```
public String getRights()
```
    Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
  - setRights
```
public CustomSearchAPI.Cse.Siterestrict.List setRights(String rights)
```
    Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
  - getSafe
```
public String getSafe()
```
    Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default)
  - setSafe
```
public CustomSearchAPI.Cse.Siterestrict.List setSafe(String safe)
```
    Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default)
  - getSearchType
```
public String getSearchType()
```
    Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search.
  - setSearchType
```
public CustomSearchAPI.Cse.Siterestrict.List setSearchType(String searchType)
```
    Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search.
  - getSiteSearch
```
public String getSiteSearch()
```
    Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).
  - setSiteSearch
```
public CustomSearchAPI.Cse.Siterestrict.List setSiteSearch(String siteSearch)
```
    Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).
  - getSiteSearchFilter
```
public String getSiteSearchFilter()
```
    Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include
  - setSiteSearchFilter
```
public CustomSearchAPI.Cse.Siterestrict.List setSiteSearchFilter(String siteSearchFilter)
```
    Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include
  - getSnippetLength
```
public Integer getSnippetLength()
```
    Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.
  - setSnippetLength
```
public CustomSearchAPI.Cse.Siterestrict.List setSnippetLength(Integer snippetLength)
```
    Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.
  - getSort
```
public String getSort()
```
    The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
  - setSort
```
public CustomSearchAPI.Cse.Siterestrict.List setSort(String sort)
```
    The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by- attribute).
  - getStart
```
public Long getStart()
```
    The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.
  - setStart
```
public CustomSearchAPI.Cse.Siterestrict.List setStart(Long start)
```
    The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.
  - set
```
public CustomSearchAPI.Cse.Siterestrict.List set(String parameterName,
                                                 Object value)
```
    Overrides:
    
    set in class CustomSearchAPIRequest<Search>

Class CustomSearchAPI.Cse.Siterestrict.List

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.customsearch.v1.CustomSearchAPIRequest

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getC2coff

setC2coff

getCr

setCr

getCx

setCx

getDateRestrict

setDateRestrict

getEnableAlternateSearchHandler

setEnableAlternateSearchHandler

getExactTerms

setExactTerms

getExcludeTerms

setExcludeTerms

getFileType

setFileType

getFilter

setFilter

getGl

setGl

getGooglehost

setGooglehost

getHighRange

setHighRange

getHl

setHl

getHq

setHq

getImgColorType

setImgColorType

getImgDominantColor

setImgDominantColor

getImgSize

setImgSize

getImgType

setImgType

getLinkSite

setLinkSite

getLowRange

setLowRange

getLr

setLr

getNum

setNum

getOrTerms

setOrTerms

getQ

setQ