Send feedback
Class Control.FilterAction (0.74.0)
Version latestkeyboard_arrow_down
public static final class Control . FilterAction extends GeneratedMessageV3 implements Control . FilterActionOrBuilder
Specified which products may be included in results.
Uses same filter as boost.
Protobuf type google.cloud.discoveryengine.v1.Control.FilterAction
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATA_STORE_FIELD_NUMBER
public static final int DATA_STORE_FIELD_NUMBER
Field Value
Type Description
int
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Control . FilterAction getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Control . FilterAction . Builder newBuilder ()
newBuilder(Control.FilterAction prototype)
public static Control . FilterAction . Builder newBuilder ( Control . FilterAction prototype )
public static Control . FilterAction parseDelimitedFrom ( InputStream input )
public static Control . FilterAction parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Control . FilterAction parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Control . FilterAction parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Control . FilterAction parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Control . FilterAction parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Control . FilterAction parseFrom ( CodedInputStream input )
public static Control . FilterAction parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Control . FilterAction parseFrom ( InputStream input )
public static Control . FilterAction parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Control . FilterAction parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Control . FilterAction parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Control . FilterAction > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDataStore()
public String 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
string data_store = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The dataStore.
getDataStoreBytes()
public ByteString getDataStoreBytes ()
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
string data_store = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for dataStore.
getDefaultInstanceForType()
public Control . FilterAction getDefaultInstanceForType ()
getFilter()
public String 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.
string filter = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The filter.
getFilterBytes()
public ByteString getFilterBytes ()
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.
string filter = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for filter.
getParserForType()
public Parser<Control . FilterAction > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Control . FilterAction . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Control . FilterAction . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Control . FilterAction . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["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-10-29 UTC."],[],[]]
