SearchRequest (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.json.GenericJson
    - - com.google.api.services.cloudsearch.v1.model.SearchRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class SearchRequest
extends com.google.api.client.json.GenericJson
```
The search API request.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Search API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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

Constructor Summary

Constructors
Constructor and Description

SearchRequest()

Constructors
Constructor and Description
`SearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchRequest`	`clone()`
`java.util.List<DataSourceRestriction>`	`getDataSourceRestrictions()` The sources to use for querying.
`java.util.List<FacetOptions>`	`getFacetOptions()`
`java.lang.Integer`	`getPageSize()` Maximum number of search results to return in one page.
`java.lang.String`	`getQuery()` The raw query string.
`QueryInterpretationOptions`	`getQueryInterpretationOptions()` Options to interpret the user query.
`RequestOptions`	`getRequestOptions()` Request options, such as the search application and user timezone.
`SortOptions`	`getSortOptions()` The options for sorting the search results
`java.lang.Integer`	`getStart()` Starting index of the results.
`SearchRequest`	`set(java.lang.String fieldName, java.lang.Object value)`
`SearchRequest`	`setDataSourceRestrictions(java.util.List<DataSourceRestriction> dataSourceRestrictions)` The sources to use for querying.
`SearchRequest`	`setFacetOptions(java.util.List<FacetOptions> facetOptions)`
`SearchRequest`	`setPageSize(java.lang.Integer pageSize)` Maximum number of search results to return in one page.
`SearchRequest`	`setQuery(java.lang.String query)` The raw query string.
`SearchRequest`	`setQueryInterpretationOptions(QueryInterpretationOptions queryInterpretationOptions)` Options to interpret the user query.
`SearchRequest`	`setRequestOptions(RequestOptions requestOptions)` Request options, such as the search application and user timezone.
`SearchRequest`	`setSortOptions(SortOptions sortOptions)` The options for sorting the search results
`SearchRequest`	`setStart(java.lang.Integer start)` Starting index of the results.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - SearchRequest
```
public SearchRequest()
```
- Method Detail
  - getDataSourceRestrictions
```
public java.util.List<DataSourceRestriction> getDataSourceRestrictions()
```
    The sources to use for querying. If not specified, all data sources from the current search application are used.
    
    Returns:
    
    value or null for none
  - setDataSourceRestrictions
```
public SearchRequest setDataSourceRestrictions(java.util.List<DataSourceRestriction> dataSourceRestrictions)
```
    The sources to use for querying. If not specified, all data sources from the current search application are used.
    
    Parameters:
    
    dataSourceRestrictions - dataSourceRestrictions or null for none
  - getFacetOptions
```
public java.util.List<FacetOptions> getFacetOptions()
```
    Returns:
    
    value or null for none
  - setFacetOptions
```
public SearchRequest setFacetOptions(java.util.List<FacetOptions> facetOptions)
```
    Parameters:
    
    facetOptions - facetOptions or null for none
  - getPageSize
```
public java.lang.Integer getPageSize()
```
    Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10.
    
    Returns:
    
    value or null for none
  - setPageSize
```
public SearchRequest setPageSize(java.lang.Integer pageSize)
```
    Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10.
    
    Parameters:
    
    pageSize - pageSize or null for none
  - getQuery
```
public java.lang.String getQuery()
```
    The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/)
    
    Returns:
    
    value or null for none
  - setQuery
```
public SearchRequest setQuery(java.lang.String query)
```
    The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/)
    
    Parameters:
    
    query - query or null for none
  - getQueryInterpretationOptions
```
public QueryInterpretationOptions getQueryInterpretationOptions()
```
    Options to interpret the user query.
    
    Returns:
    
    value or null for none
  - setQueryInterpretationOptions
```
public SearchRequest setQueryInterpretationOptions(QueryInterpretationOptions queryInterpretationOptions)
```
    Options to interpret the user query.
    
    Parameters:
    
    queryInterpretationOptions - queryInterpretationOptions or null for none
  - getRequestOptions
```
public RequestOptions getRequestOptions()
```
    Request options, such as the search application and user timezone.
    
    Returns:
    
    value or null for none
  - setRequestOptions
```
public SearchRequest setRequestOptions(RequestOptions requestOptions)
```
    Request options, such as the search application and user timezone.
    
    Parameters:
    
    requestOptions - requestOptions or null for none
  - getSortOptions
```
public SortOptions getSortOptions()
```
    The options for sorting the search results
    
    Returns:
    
    value or null for none
  - setSortOptions
```
public SearchRequest setSortOptions(SortOptions sortOptions)
```
    The options for sorting the search results
    
    Parameters:
    
    sortOptions - sortOptions or null for none
  - getStart
```
public java.lang.Integer getStart()
```
    Starting index of the results.
    
    Returns:
    
    value or null for none
  - setStart
```
public SearchRequest setStart(java.lang.Integer start)
```
    Starting index of the results.
    
    Parameters:
    
    start - start or null for none
  - set
```
public SearchRequest set(java.lang.String fieldName,
                         java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public SearchRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Search API v1 (revision 47)

Class SearchRequest

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

Constructor Summary

Method Summary

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

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

SearchRequest

Method Detail

getDataSourceRestrictions

setDataSourceRestrictions

getFacetOptions

setFacetOptions

getPageSize

setPageSize

getQuery

setQuery

getQueryInterpretationOptions

setQueryInterpretationOptions

getRequestOptions

setRequestOptions

getSortOptions

setSortOptions

getStart

setStart

set

clone