Send feedback
Class Control.FilterAction.Builder (0.74.0)
Version latestkeyboard_arrow_down
public static final class Control . FilterAction . Builder extends GeneratedMessageV3 . Builder<Control . FilterAction . Builder > implements Control . FilterActionOrBuilder
Specified which products may be included in results.
Uses same filter as boost.
Protobuf type google.cloud.discoveryengine.v1beta.Control.FilterAction
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Control . FilterAction . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public Control . FilterAction build ()
buildPartial()
public Control . FilterAction buildPartial ()
clear()
public Control . FilterAction . Builder clear ()
Overrides
clearDataStore()
public Control . FilterAction . Builder clearDataStore ()
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) = { ... }
clearField(Descriptors.FieldDescriptor field)
public Control . FilterAction . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearFilter()
public Control . FilterAction . Builder clearFilter ()
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public Control . FilterAction . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clone()
public Control . FilterAction . Builder clone ()
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 ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
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.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(Control.FilterAction other)
public Control . FilterAction . Builder mergeFrom ( Control . FilterAction other )
public Control . FilterAction . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public Control . FilterAction . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Control . FilterAction . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setDataStore(String value)
public Control . FilterAction . Builder setDataStore ( String value )
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) = { ... }
Parameter
Name Description
valueString The dataStore to set.
setDataStoreBytes(ByteString value)
public Control . FilterAction . Builder setDataStoreBytes ( ByteString value )
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) = { ... }
Parameter
Name Description
valueByteString The bytes for dataStore to set.
setField(Descriptors.FieldDescriptor field, Object value)
public Control . FilterAction . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setFilter(String value)
public Control . FilterAction . Builder setFilter ( String value )
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];
Parameter
Name Description
valueString The filter to set.
setFilterBytes(ByteString value)
public Control . FilterAction . Builder setFilterBytes ( ByteString value )
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];
Parameter
Name Description
valueByteString The bytes for filter to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Control . FilterAction . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Control . FilterAction . Builder setUnknownFields ( UnknownFieldSet unknownFields )
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."],[],[]]
