Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class FilterAction.
Specified which products may be included in results.
Uses same filter as boost.
Generated from protobuf message google.cloud.discoveryengine.v1.Control.FilterAction
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ ControlMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ filter |
string
Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
↳ data_store |
string
Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
getFilter
Required. A filter to apply on the matching condition results.
Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Required. A filter to apply on the matching condition results.
Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataStore
Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g.
projects/123/locations/global/collections/default_collection/dataStores/default_data_store
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataStore
Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g.
projects/123/locations/global/collections/default_collection/dataStores/default_data_store
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|