Customsearch.Cse.Siterestrict.List (CustomSearch API v1-rev20181001-1.30.9)

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.CustomsearchRequest<Search>
        
        com.google.api.services.customsearch.Customsearch.Cse.Siterestrict.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Customsearch.Cse.Siterestrict
```
public class Customsearch.Cse.Siterestrict.List
extends CustomsearchRequest<Search>
```

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`	`List(String q)` Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getC2coff()` Turns off the translation between zh-CN and zh-TW.
`String`	`getCr()` Country restrict(s).
`String`	`getCx()` The custom search engine ID to scope this search query
`String`	`getDateRestrict()` Specifies all search results are from a time period
`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()` Returns images of a specified type.
`String`	`getFilter()` Controls turning on or off the duplicate content filter.
`String`	`getGl()` Geolocation of end user.
`String`	`getGooglehost()` The local Google domain to use to perform the search.
`String`	`getHighRange()` Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
`String`	`getHl()` Sets the user interface language.
`String`	`getHq()` Appends the extra query terms to the query.
`String`	`getImgColorType()` Returns black and white, grayscale, or color images: mono, gray, and color.
`String`	`getImgDominantColor()` Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.
`String`	`getImgSize()` Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
`String`	`getImgType()` Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
`String`	`getLinkSite()` Specifies that all search results should contain a link to a particular URL
`String`	`getLowRange()` Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
`String`	`getLr()` The language restriction for the search results
`Long`	`getNum()` Number of search results to return [default: 10]
`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()` Specifies that all search results should be pages that are related to the specified URL
`String`	`getRights()` Filters based on licensing.
`String`	`getSafe()` Search safety level [default: off]
`String`	`getSearchType()` Specifies the search type: image.
`String`	`getSiteSearch()` Specifies all search results should be pages from a given site
`String`	`getSiteSearchFilter()` Controls whether to include or exclude results from the site named in the as_sitesearch parameter
`String`	`getSort()` The sort expression to apply to the results
`Long`	`getStart()` The index of the first result to return
`Customsearch.Cse.Siterestrict.List`	`set(String parameterName, Object value)`
`Customsearch.Cse.Siterestrict.List`	`setAlt(String alt)` Data format for the response.
`Customsearch.Cse.Siterestrict.List`	`setC2coff(String c2coff)` Turns off the translation between zh-CN and zh-TW.
`Customsearch.Cse.Siterestrict.List`	`setCr(String cr)` Country restrict(s).
`Customsearch.Cse.Siterestrict.List`	`setCx(String cx)` The custom search engine ID to scope this search query
`Customsearch.Cse.Siterestrict.List`	`setDateRestrict(String dateRestrict)` Specifies all search results are from a time period
`Customsearch.Cse.Siterestrict.List`	`setExactTerms(String exactTerms)` Identifies a phrase that all documents in the search results must contain
`Customsearch.Cse.Siterestrict.List`	`setExcludeTerms(String excludeTerms)` Identifies a word or phrase that should not appear in any documents in the search results
`Customsearch.Cse.Siterestrict.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Customsearch.Cse.Siterestrict.List`	`setFileType(String fileType)` Returns images of a specified type.
`Customsearch.Cse.Siterestrict.List`	`setFilter(String filter)` Controls turning on or off the duplicate content filter.
`Customsearch.Cse.Siterestrict.List`	`setGl(String gl)` Geolocation of end user.
`Customsearch.Cse.Siterestrict.List`	`setGooglehost(String googlehost)` The local Google domain to use to perform the search.
`Customsearch.Cse.Siterestrict.List`	`setHighRange(String highRange)` Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
`Customsearch.Cse.Siterestrict.List`	`setHl(String hl)` Sets the user interface language.
`Customsearch.Cse.Siterestrict.List`	`setHq(String hq)` Appends the extra query terms to the query.
`Customsearch.Cse.Siterestrict.List`	`setImgColorType(String imgColorType)` Returns black and white, grayscale, or color images: mono, gray, and color.
`Customsearch.Cse.Siterestrict.List`	`setImgDominantColor(String imgDominantColor)` Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.
`Customsearch.Cse.Siterestrict.List`	`setImgSize(String imgSize)` Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
`Customsearch.Cse.Siterestrict.List`	`setImgType(String imgType)` Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
`Customsearch.Cse.Siterestrict.List`	`setKey(String key)` API key.
`Customsearch.Cse.Siterestrict.List`	`setLinkSite(String linkSite)` Specifies that all search results should contain a link to a particular URL
`Customsearch.Cse.Siterestrict.List`	`setLowRange(String lowRange)` Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
`Customsearch.Cse.Siterestrict.List`	`setLr(String lr)` The language restriction for the search results
`Customsearch.Cse.Siterestrict.List`	`setNum(Long num)` Number of search results to return
`Customsearch.Cse.Siterestrict.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Customsearch.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
`Customsearch.Cse.Siterestrict.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Customsearch.Cse.Siterestrict.List`	`setQ(String q)` Query
`Customsearch.Cse.Siterestrict.List`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Customsearch.Cse.Siterestrict.List`	`setRelatedSite(String relatedSite)` Specifies that all search results should be pages that are related to the specified URL
`Customsearch.Cse.Siterestrict.List`	`setRights(String rights)` Filters based on licensing.
`Customsearch.Cse.Siterestrict.List`	`setSafe(String safe)` Search safety level
`Customsearch.Cse.Siterestrict.List`	`setSearchType(String searchType)` Specifies the search type: image.
`Customsearch.Cse.Siterestrict.List`	`setSiteSearch(String siteSearch)` Specifies all search results should be pages from a given site
`Customsearch.Cse.Siterestrict.List`	`setSiteSearchFilter(String siteSearchFilter)` Controls whether to include or exclude results from the site named in the as_sitesearch parameter
`Customsearch.Cse.Siterestrict.List`	`setSort(String sort)` The sort expression to apply to the results
`Customsearch.Cse.Siterestrict.List`	`setStart(Long start)` The index of the first result to return
`Customsearch.Cse.Siterestrict.List`	`setUserIp(String userIp)` Deprecated.

Methods inherited from class com.google.api.services.customsearch.CustomsearchRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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.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(String q)
```
    Returns metadata about the search performed, metadata about the custom search 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.
    Customsearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    q - Query
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<Search>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Search>
    
    Throws:
    
    IOException
  - setAlt
```
public Customsearch.Cse.Siterestrict.List setAlt(String alt)
```
    Description copied from class: CustomsearchRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class CustomsearchRequest<Search>
  - setFields
```
public Customsearch.Cse.Siterestrict.List setFields(String fields)
```
    Description copied from class: CustomsearchRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CustomsearchRequest<Search>
  - setKey
```
public Customsearch.Cse.Siterestrict.List setKey(String key)
```
    Description copied from class: CustomsearchRequest
    
    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 CustomsearchRequest<Search>
  - setOauthToken
```
public Customsearch.Cse.Siterestrict.List setOauthToken(String oauthToken)
```
    Description copied from class: CustomsearchRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CustomsearchRequest<Search>
  - setPrettyPrint
```
public Customsearch.Cse.Siterestrict.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CustomsearchRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CustomsearchRequest<Search>
  - setQuotaUser
```
public Customsearch.Cse.Siterestrict.List setQuotaUser(String quotaUser)
```
    Description copied from class: CustomsearchRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class CustomsearchRequest<Search>
  - setUserIp
```
public Customsearch.Cse.Siterestrict.List setUserIp(String userIp)
```
    Description copied from class: CustomsearchRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class CustomsearchRequest<Search>
  - getQ
```
public String getQ()
```
    Query
  - setQ
```
public Customsearch.Cse.Siterestrict.List setQ(String q)
```
    Query
  - getC2coff
```
public String getC2coff()
```
    Turns off the translation between zh-CN and zh-TW.
  - setC2coff
```
public Customsearch.Cse.Siterestrict.List setC2coff(String c2coff)
```
    Turns off the translation between zh-CN and zh-TW.
  - getCr
```
public String getCr()
```
    Country restrict(s).
  - setCr
```
public Customsearch.Cse.Siterestrict.List setCr(String cr)
```
    Country restrict(s).
  - getCx
```
public String getCx()
```
    The custom search engine ID to scope this search query
  - setCx
```
public Customsearch.Cse.Siterestrict.List setCx(String cx)
```
    The custom search engine ID to scope this search query
  - getDateRestrict
```
public String getDateRestrict()
```
    Specifies all search results are from a time period
  - setDateRestrict
```
public Customsearch.Cse.Siterestrict.List setDateRestrict(String dateRestrict)
```
    Specifies all search results are from a time period
  - getExactTerms
```
public String getExactTerms()
```
    Identifies a phrase that all documents in the search results must contain
  - setExactTerms
```
public Customsearch.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 Customsearch.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()
```
    Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...
  - setFileType
```
public Customsearch.Cse.Siterestrict.List setFileType(String fileType)
```
    Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...
  - getFilter
```
public String getFilter()
```
    Controls turning on or off the duplicate content filter.
  - setFilter
```
public Customsearch.Cse.Siterestrict.List setFilter(String filter)
```
    Controls turning on or off the duplicate content filter.
  - getGl
```
public String getGl()
```
    Geolocation of end user.
  - setGl
```
public Customsearch.Cse.Siterestrict.List setGl(String gl)
```
    Geolocation of end user.
  - getGooglehost
```
public String getGooglehost()
```
    The local Google domain to use to perform the search.
  - setGooglehost
```
public Customsearch.Cse.Siterestrict.List setGooglehost(String googlehost)
```
    The local Google domain to use to perform the search.
  - getHighRange
```
public String getHighRange()
```
    Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  - setHighRange
```
public Customsearch.Cse.Siterestrict.List setHighRange(String highRange)
```
    Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  - getHl
```
public String getHl()
```
    Sets the user interface language.
  - setHl
```
public Customsearch.Cse.Siterestrict.List setHl(String hl)
```
    Sets the user interface language.
  - getHq
```
public String getHq()
```
    Appends the extra query terms to the query.
  - setHq
```
public Customsearch.Cse.Siterestrict.List setHq(String hq)
```
    Appends the extra query terms to the query.
  - getImgColorType
```
public String getImgColorType()
```
    Returns black and white, grayscale, or color images: mono, gray, and color.
  - setImgColorType
```
public Customsearch.Cse.Siterestrict.List setImgColorType(String imgColorType)
```
    Returns black and white, grayscale, or color images: mono, gray, and color.
  - getImgDominantColor
```
public String getImgDominantColor()
```
    Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.
  - setImgDominantColor
```
public Customsearch.Cse.Siterestrict.List setImgDominantColor(String imgDominantColor)
```
    Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.
  - getImgSize
```
public String getImgSize()
```
    Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
  - setImgSize
```
public Customsearch.Cse.Siterestrict.List setImgSize(String imgSize)
```
    Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
  - getImgType
```
public String getImgType()
```
    Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
  - setImgType
```
public Customsearch.Cse.Siterestrict.List setImgType(String imgType)
```
    Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
  - getLinkSite
```
public String getLinkSite()
```
    Specifies that all search results should contain a link to a particular URL
  - setLinkSite
```
public Customsearch.Cse.Siterestrict.List setLinkSite(String linkSite)
```
    Specifies that all search results should contain a link to a particular URL
  - getLowRange
```
public String getLowRange()
```
    Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  - setLowRange
```
public Customsearch.Cse.Siterestrict.List setLowRange(String lowRange)
```
    Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  - getLr
```
public String getLr()
```
    The language restriction for the search results
  - setLr
```
public Customsearch.Cse.Siterestrict.List setLr(String lr)
```
    The language restriction for the search results
  - getNum
```
public Long getNum()
```
    Number of search results to return [default: 10]
  - setNum
```
public Customsearch.Cse.Siterestrict.List setNum(Long num)
```
    Number of search results to return
  - 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 Customsearch.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
  - getRelatedSite
```
public String getRelatedSite()
```
    Specifies that all search results should be pages that are related to the specified URL
  - setRelatedSite
```
public Customsearch.Cse.Siterestrict.List setRelatedSite(String relatedSite)
```
    Specifies that all search results should be pages that are related to the specified URL
  - 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.
  - setRights
```
public Customsearch.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.
  - getSafe
```
public String getSafe()
```
    Search safety level [default: off]
  - setSafe
```
public Customsearch.Cse.Siterestrict.List setSafe(String safe)
```
    Search safety level
  - getSearchType
```
public String getSearchType()
```
    Specifies the search type: image.
  - setSearchType
```
public Customsearch.Cse.Siterestrict.List setSearchType(String searchType)
```
    Specifies the search type: image.
  - getSiteSearch
```
public String getSiteSearch()
```
    Specifies all search results should be pages from a given site
  - setSiteSearch
```
public Customsearch.Cse.Siterestrict.List setSiteSearch(String siteSearch)
```
    Specifies all search results should be pages from a given site
  - getSiteSearchFilter
```
public String getSiteSearchFilter()
```
    Controls whether to include or exclude results from the site named in the as_sitesearch parameter
  - setSiteSearchFilter
```
public Customsearch.Cse.Siterestrict.List setSiteSearchFilter(String siteSearchFilter)
```
    Controls whether to include or exclude results from the site named in the as_sitesearch parameter
  - getSort
```
public String getSort()
```
    The sort expression to apply to the results
  - setSort
```
public Customsearch.Cse.Siterestrict.List setSort(String sort)
```
    The sort expression to apply to the results
  - getStart
```
public Long getStart()
```
    The index of the first result to return
  - setStart
```
public Customsearch.Cse.Siterestrict.List setStart(Long start)
```
    The index of the first result to return
  - set
```
public Customsearch.Cse.Siterestrict.List set(String parameterName,
                                              Object value)
```
    Overrides:
    
    set in class CustomsearchRequest<Search>

Class Customsearch.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.CustomsearchRequest

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

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getQ

setQ

getC2coff

setC2coff

getCr

setCr

getCx

setCx

getDateRestrict

setDateRestrict

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

getRelatedSite

setRelatedSite

getRights

setRights

getSafe

setSafe