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 messagegoogle.cloud.discoveryengine.v1.Control.FilterAction
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ Control
Methods
__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-orderMaximum 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.
[[["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 FilterAction (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.Control.FilterAction)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.Control.FilterAction)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.Control.FilterAction)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.Control.FilterAction)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.Control.FilterAction)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.Control.FilterAction)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.Control.FilterAction)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.Control.FilterAction)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.Control.FilterAction)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.Control.FilterAction)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.Control.FilterAction)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.Control.FilterAction)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.Control.FilterAction)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.Control.FilterAction)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.Control.FilterAction)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.Control.FilterAction)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.Control.FilterAction) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class FilterAction.\n\nSpecified which products may be included in results.\n\nUses same filter as boost.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.Control.FilterAction`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ Control\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFilter\n\nRequired. A filter to apply on the matching condition results.\n\nRequired\nSyntax documentation:\n\u003chttps://cloud.google.com/retail/docs/filter-and-order\u003e\nMaximum length is 5000 characters. Otherwise an INVALID\nARGUMENT error is thrown.\n\n### setFilter\n\nRequired. A filter to apply on the matching condition results.\n\nRequired\nSyntax documentation:\n\u003chttps://cloud.google.com/retail/docs/filter-and-order\u003e\nMaximum length is 5000 characters. Otherwise an INVALID\nARGUMENT error is thrown.\n\n### getDataStore\n\nRequired. Specifies which data store's documents can be filtered by this\ncontrol. Full data store name e.g.\n\nprojects/123/locations/global/collections/default_collection/dataStores/default_data_store\n\n### setDataStore\n\nRequired. Specifies which data store's documents can be filtered by this\ncontrol. Full data store name e.g.\n\nprojects/123/locations/global/collections/default_collection/dataStores/default_data_store"]]