com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.

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 Discovery Engine 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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	clone()
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec	getBoostSpec() Optional.
String	getCustomSearchOperators() Optional.
String	getDataStore() Required.
String	getFilter() Optional.
Integer	getNumResults() Optional.
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	setBoostSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec boostSpec) Optional.
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	setCustomSearchOperators(String customSearchOperators) Optional.
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	setDataStore(String dataStore) Required.
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	setFilter(String filter) Optional.
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec	setNumResults(Integer numResults) Optional.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec()

Method Detail

getBoostSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec getBoostSpec()

Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

Returns:

value or null for none

setBoostSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec setBoostSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec boostSpec)

Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

Parameters:

boostSpec - boostSpec or null for none

getCustomSearchOperators

public String getCustomSearchOperators()

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).

Returns:

value or null for none

setCustomSearchOperators

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec setCustomSearchOperators(String customSearchOperators)

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).

Parameters:

customSearchOperators - customSearchOperators or null for none

getDataStore

public String getDataStore()

Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/col lections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.

Returns:

value or null for none

setDataStore

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec setDataStore(String dataStore)

Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/col lections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.

Parameters:

dataStore - dataStore or null for none

getFilter

public String getFilter()

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative- ai-app-builder/docs/filter-search-metadata)

Returns:

value or null for none

setFilter

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec setFilter(String filter)

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative- ai-app-builder/docs/filter-search-metadata)

Parameters:

filter - filter or null for none

getNumResults

public Integer getNumResults()

Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.

Returns:

value or null for none

setNumResults

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec setNumResults(Integer numResults)

Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.

Parameters:

numResults - numResults or null for none

set

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec set(String fieldName,
                                                                       Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec clone()

Overrides:

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