public static final class Control.FilterAction.Builder extends GeneratedMessage.Builder<Control.FilterAction.Builder> implements Control.FilterActionOrBuilderSpecified which products may be included in results. Uses same filter as boost.
Protobuf type google.cloud.discoveryengine.v1beta.Control.FilterAction
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Control.FilterAction.BuilderImplements
Control.FilterActionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public Control.FilterAction build()| Returns | |
|---|---|
| Type | Description |
Control.FilterAction |
|
buildPartial()
public Control.FilterAction buildPartial()| Returns | |
|---|---|
| Type | Description |
Control.FilterAction |
|
clear()
public Control.FilterAction.Builder clear()| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
|
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
This builder for chaining. |
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];
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
This builder for chaining. |
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()| Returns | |
|---|---|
| Type | Description |
Control.FilterAction |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Control.FilterAction other)
public Control.FilterAction.Builder mergeFrom(Control.FilterAction other)| Parameter | |
|---|---|
| Name | Description |
other |
Control.FilterAction |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Control.FilterAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Control.FilterAction.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
|
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 |
value |
StringThe dataStore to set. |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
This builder for chaining. |
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 |
value |
ByteStringThe bytes for dataStore to set. |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
This builder for chaining. |
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 |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
This builder for chaining. |
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 |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
Control.FilterAction.Builder |
This builder for chaining. |