com.google.cloud.discoveryengine.v1

Class Control.FilterAction.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Control.FilterAction.Builder>

com.google.cloud.discoveryengine.v1.Control.FilterAction.Builder

All Implemented Interfaces:

Control.FilterActionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Control.FilterAction

public static final class Control.FilterAction.Builder
extends com.google.protobuf.GeneratedMessage.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.v1.Control.FilterAction

Method Summary

Modifier and Type	Method and Description
Control.FilterAction	build()
Control.FilterAction	buildPartial()
Control.FilterAction.Builder	clear()
Control.FilterAction.Builder	clearDataStore() Required.
Control.FilterAction.Builder	clearFilter() Required.
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
Control.FilterAction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Control.FilterAction.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Control.FilterAction.Builder	mergeFrom(Control.FilterAction other)
Control.FilterAction.Builder	mergeFrom(com.google.protobuf.Message other)
Control.FilterAction.Builder	setDataStore(String value) Required.
Control.FilterAction.Builder	setDataStoreBytes(com.google.protobuf.ByteString value) Required.
Control.FilterAction.Builder	setFilter(String value) Required.
Control.FilterAction.Builder	setFilterBytes(com.google.protobuf.ByteString value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Control.FilterAction.Builder>

clear

public Control.FilterAction.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Control.FilterAction.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Control.FilterAction.Builder>

getDefaultInstanceForType

public Control.FilterAction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Control.FilterAction build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Control.FilterAction buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Control.FilterAction.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Control.FilterAction.Builder>

mergeFrom

public Control.FilterAction.Builder mergeFrom(Control.FilterAction other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Control.FilterAction.Builder>

mergeFrom

public Control.FilterAction.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Control.FilterAction.Builder>

Throws:

IOException

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];

Specified by:

getFilter in interface Control.FilterActionOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.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];

Specified by:

getFilterBytes in interface Control.FilterActionOrBuilder

Returns:

The bytes for filter.

setFilter

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];

Parameters:

value - The filter to set.

Returns:

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:

This builder for chaining.

setFilterBytes

public Control.FilterAction.Builder setFilterBytes(com.google.protobuf.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];

Parameters:

value - The bytes for filter to set.

Returns:

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) = { ... }

Specified by:

getDataStore in interface Control.FilterActionOrBuilder

Returns:

The dataStore.

getDataStoreBytes

public com.google.protobuf.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) = { ... }

Specified by:

getDataStoreBytes in interface Control.FilterActionOrBuilder

Returns:

The bytes for dataStore.

setDataStore

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) = { ... }

Parameters:

value - The dataStore to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setDataStoreBytes

public Control.FilterAction.Builder setDataStoreBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for dataStore to set.

Returns:

This builder for chaining.