Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DataStoreSpec.
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.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ data_store
string
Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
↳ filter
string
Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering
Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting
↳ custom_search_operators
string
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.
getDataStore
Required. Full resource name of
DataStore, such as
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
Returns
Type
Description
string
setDataStore
Required. Full resource name of
DataStore, such as
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filter specification to filter documents in the data store
specified by data_store field. For more information on filtering, see
Filtering
Returns
Type
Description
string
setFilter
Optional. Filter specification to filter documents in the data store
specified by data_store field. For more information on filtering, see
Filtering
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBoostSpec
Optional. Boost specification to boost certain documents.
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.
Returns
Type
Description
string
setCustomSearchOperators
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class DataStoreSpec (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.SearchRequest.DataStoreSpec)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.SearchRequest.DataStoreSpec)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.SearchRequest.DataStoreSpec)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.SearchRequest.DataStoreSpec)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.SearchRequest.DataStoreSpec)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.SearchRequest.DataStoreSpec)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.SearchRequest.DataStoreSpec)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.SearchRequest.DataStoreSpec)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.SearchRequest.DataStoreSpec)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.SearchRequest.DataStoreSpec)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.SearchRequest.DataStoreSpec)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.SearchRequest.DataStoreSpec)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.SearchRequest.DataStoreSpec)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.SearchRequest.DataStoreSpec)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.SearchRequest.DataStoreSpec)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.SearchRequest.DataStoreSpec)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.SearchRequest.DataStoreSpec) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DataStoreSpec.\n\nA struct to define data stores to filter on in a search call and\nconfigurations for those data stores. Otherwise, an `INVALID_ARGUMENT`\nerror is returned.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ SearchRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDataStore\n\nRequired. Full resource name of\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore), such as\n`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.\n\n### setDataStore\n\nRequired. Full resource name of\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore), such as\n`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.\n\n### getFilter\n\nOptional. Filter specification to filter documents in the data store\nspecified by data_store field. For more information on filtering, see\n[Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)\n\n### setFilter\n\nOptional. Filter specification to filter documents in the data store\nspecified by data_store field. For more information on filtering, see\n[Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)\n\n### getBoostSpec\n\nOptional. Boost specification to boost certain documents.\n\nFor more information on boosting, see\n[Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)\n\n### hasBoostSpec\n\n### clearBoostSpec\n\n### setBoostSpec\n\nOptional. Boost specification to boost certain documents.\n\nFor more information on boosting, see\n[Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)\n\n### getCustomSearchOperators\n\nOptional. Custom search operators which if specified will be used to\nfilter results from workspace data stores. For more information on custom\nsearch operators, see\n[SearchOperators](https://support.google.com/cloudsearch/answer/6172299).\n\n### setCustomSearchOperators\n\nOptional. Custom search operators which if specified will be used to\nfilter results from workspace data stores. For more information on custom\nsearch operators, see\n[SearchOperators](https://support.google.com/cloudsearch/answer/6172299)."]]
