com.google.api.services.cloudsearch.v1.model

Class SuggestRequest

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.SuggestRequest

All Implemented Interfaces:

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

public final class SuggestRequest
extends com.google.api.client.json.GenericJson

Request of suggest API.

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
SuggestRequest()

Method Summary

Modifier and Type	Method and Description
SuggestRequest	clone()
java.util.List<DataSourceRestriction>	getDataSourceRestrictions() The sources to use for suggestions.
java.lang.String	getQuery() Partial query for which autocomplete suggestions will be shown.
RequestOptions	getRequestOptions() Request options, such as the search application and user timezone.
SuggestRequest	set(java.lang.String fieldName, java.lang.Object value)
SuggestRequest	setDataSourceRestrictions(java.util.List<DataSourceRestriction> dataSourceRestrictions) The sources to use for suggestions.
SuggestRequest	setQuery(java.lang.String query) Partial query for which autocomplete suggestions will be shown.
SuggestRequest	setRequestOptions(RequestOptions requestOptions) Request options, such as the search application and user timezone.

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

SuggestRequest

public SuggestRequest()

Method Detail

getDataSourceRestrictions

public java.util.List<DataSourceRestriction> getDataSourceRestrictions()

The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are supported only for third party data sources and people (i.e. PredefinedSource.PERSON).

Returns:

value or null for none

setDataSourceRestrictions

public SuggestRequest setDataSourceRestrictions(java.util.List<DataSourceRestriction> dataSourceRestrictions)

The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are supported only for third party data sources and people (i.e. PredefinedSource.PERSON).

Parameters:

dataSourceRestrictions - dataSourceRestrictions or null for none

getQuery

public java.lang.String getQuery()

Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on.

Returns:

value or null for none

setQuery

public SuggestRequest setQuery(java.lang.String query)

Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on.

Parameters:

query - query 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 SuggestRequest setRequestOptions(RequestOptions requestOptions)

Request options, such as the search application and user timezone.

Parameters:

requestOptions - requestOptions or null for none

set

public SuggestRequest set(java.lang.String fieldName,
                          java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SuggestRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson