CloudSearch.Query.Sources.List (Cloud Search API v1 (Rev. 47) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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.cloudsearch.v1.CloudSearchRequest<ListQuerySourcesResponse>
        
        com.google.api.services.cloudsearch.v1.CloudSearch.Query.Sources.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

CloudSearch.Query.Sources
```
public class CloudSearch.Query.Sources.List
extends CloudSearchRequest<ListQuerySourcesResponse>
```

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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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()
Returns list of sources that user can use for Search and Suggest APIs.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Returns list of sources that user can use for Search and Suggest APIs.

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()`
`java.lang.String`	`getPageToken()` Number of sources to return in the response.
`java.lang.Boolean`	`getRequestOptionsDebugOptionsEnableDebugging()` If you are asked by Google to help with debugging, set this field.
`java.lang.String`	`getRequestOptionsLanguageCode()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`java.lang.String`	`getRequestOptionsSearchApplicationId()` Id of the application created using SearchApplicationsService.
`java.lang.String`	`getRequestOptionsTimeZone()` Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney".
`CloudSearch.Query.Sources.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`CloudSearch.Query.Sources.List`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`CloudSearch.Query.Sources.List`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`CloudSearch.Query.Sources.List`	`setAlt(java.lang.String alt)` Data format for response.
`CloudSearch.Query.Sources.List`	`setCallback(java.lang.String callback)` JSONP
`CloudSearch.Query.Sources.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`CloudSearch.Query.Sources.List`	`setKey(java.lang.String key)` API key.
`CloudSearch.Query.Sources.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`CloudSearch.Query.Sources.List`	`setPageToken(java.lang.String pageToken)` Number of sources to return in the response.
`CloudSearch.Query.Sources.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudSearch.Query.Sources.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudSearch.Query.Sources.List`	`setRequestOptionsDebugOptionsEnableDebugging(java.lang.Boolean requestOptionsDebugOptionsEnableDebugging)` If you are asked by Google to help with debugging, set this field.
`CloudSearch.Query.Sources.List`	`setRequestOptionsLanguageCode(java.lang.String requestOptionsLanguageCode)` The BCP-47 language code, such as "en-US" or "sr-Latn".
`CloudSearch.Query.Sources.List`	`setRequestOptionsSearchApplicationId(java.lang.String requestOptionsSearchApplicationId)` Id of the application created using SearchApplicationsService.
`CloudSearch.Query.Sources.List`	`setRequestOptionsTimeZone(java.lang.String requestOptionsTimeZone)` Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney".
`CloudSearch.Query.Sources.List`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`CloudSearch.Query.Sources.List`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudsearch.v1.CloudSearchRequest
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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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 list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud- search/docs/guides/delegation/). Create a request for the method "sources.list". This request holds the parameters needed by the the cloudsearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudSearch.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 java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListQuerySourcesResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListQuerySourcesResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public CloudSearch.Query.Sources.List set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: CloudSearchRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudSearchRequest<ListQuerySourcesResponse>
  - setAccessToken
```
public CloudSearch.Query.Sources.List setAccessToken(java.lang.String accessToken)
```
    Description copied from class: CloudSearchRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudSearchRequest<ListQuerySourcesResponse>
  - setAlt
```
public CloudSearch.Query.Sources.List setAlt(java.lang.String alt)
```
    Description copied from class: CloudSearchRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudSearchRequest<ListQuerySourcesResponse>
  - setCallback
```
public CloudSearch.Query.Sources.List setCallback(java.lang.String callback)
```
    Description copied from class: CloudSearchRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudSearchRequest<ListQuerySourcesResponse>
  - setFields
```
public CloudSearch.Query.Sources.List setFields(java.lang.String fields)
```
    Description copied from class: CloudSearchRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudSearchRequest<ListQuerySourcesResponse>
  - setKey
```
public CloudSearch.Query.Sources.List setKey(java.lang.String key)
```
    Description copied from class: CloudSearchRequest
    
    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 CloudSearchRequest<ListQuerySourcesResponse>
  - setOauthToken
```
public CloudSearch.Query.Sources.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: CloudSearchRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudSearchRequest<ListQuerySourcesResponse>
  - setPrettyPrint
```
public CloudSearch.Query.Sources.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: CloudSearchRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudSearchRequest<ListQuerySourcesResponse>
  - setQuotaUser
```
public CloudSearch.Query.Sources.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: CloudSearchRequest
    
    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 CloudSearchRequest<ListQuerySourcesResponse>
  - setUploadType
```
public CloudSearch.Query.Sources.List setUploadType(java.lang.String uploadType)
```
    Description copied from class: CloudSearchRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudSearchRequest<ListQuerySourcesResponse>
  - setUploadProtocol
```
public CloudSearch.Query.Sources.List setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: CloudSearchRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudSearchRequest<ListQuerySourcesResponse>
  - getRequestOptionsLanguageCode
```
public java.lang.String getRequestOptionsLanguageCode()
```
    The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
  - setRequestOptionsLanguageCode
```
public CloudSearch.Query.Sources.List setRequestOptionsLanguageCode(java.lang.String requestOptionsLanguageCode)
```
    The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
  - getRequestOptionsSearchApplicationId
```
public java.lang.String getRequestOptionsSearchApplicationId()
```
    Id of the application created using SearchApplicationsService.
  - setRequestOptionsSearchApplicationId
```
public CloudSearch.Query.Sources.List setRequestOptionsSearchApplicationId(java.lang.String requestOptionsSearchApplicationId)
```
    Id of the application created using SearchApplicationsService.
  - getRequestOptionsTimeZone
```
public java.lang.String getRequestOptionsTimeZone()
```
    Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
  - setRequestOptionsTimeZone
```
public CloudSearch.Query.Sources.List setRequestOptionsTimeZone(java.lang.String requestOptionsTimeZone)
```
    Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Number of sources to return in the response.
  - setPageToken
```
public CloudSearch.Query.Sources.List setPageToken(java.lang.String pageToken)
```
    Number of sources to return in the response.
  - getRequestOptionsDebugOptionsEnableDebugging
```
public java.lang.Boolean getRequestOptionsDebugOptionsEnableDebugging()
```
    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
  - setRequestOptionsDebugOptionsEnableDebugging
```
public CloudSearch.Query.Sources.List setRequestOptionsDebugOptionsEnableDebugging(java.lang.Boolean requestOptionsDebugOptionsEnableDebugging)
```
    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
  - set
```
public CloudSearch.Query.Sources.List set(java.lang.String parameterName,
                                          java.lang.Object value)
```
    Overrides:
    
    set in class CloudSearchRequest<ListQuerySourcesResponse>

Cloud Search API v1 (revision 47)

Class CloudSearch.Query.Sources.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.cloudsearch.v1.CloudSearchRequest

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

getRequestOptionsLanguageCode

setRequestOptionsLanguageCode

getRequestOptionsSearchApplicationId

setRequestOptionsSearchApplicationId

getRequestOptionsTimeZone

setRequestOptionsTimeZone

getPageToken

setPageToken

getRequestOptionsDebugOptionsEnableDebugging

setRequestOptionsDebugOptionsEnableDebugging

set