Google Cloud Discovery Engine V1 Client - Class DataStoreSpec (1.6.0)

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
`↳ boost_spec`	`BoostSpec` 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.

For more information on boosting, see Boosting

Returns
Type	Description
`BoostSpec\|null`

hasBoostSpec

clearBoostSpec

setBoostSpec