Class TextSearch.Builder (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.4.0
• 0.3.0
• 0.1.0

public static final class TextSearch.Builder extends GeneratedMessage.Builder<TextSearch.Builder> implements TextSearchOrBuilder

Defines a text search operation.

Protobuf type google.cloud.vectorsearch.v1beta.TextSearch

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > TextSearch.Builder

Implements

TextSearchOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllDataFieldNames(Iterable<String> values)

public TextSearch.Builder addAllDataFieldNames(Iterable<String> values)

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
values	Iterable<String> The dataFieldNames to add.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

addDataFieldNames(String value)

public TextSearch.Builder addDataFieldNames(String value)

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The dataFieldNames to add.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

addDataFieldNamesBytes(ByteString value)

public TextSearch.Builder addDataFieldNamesBytes(ByteString value)

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes of the dataFieldNames to add.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

build()

public TextSearch build()

Returns
Type	Description
TextSearch

buildPartial()

public TextSearch buildPartial()

Returns
Type	Description
TextSearch

clear()

public TextSearch.Builder clear()

Returns
Type	Description
TextSearch.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearDataFieldNames()

public TextSearch.Builder clearDataFieldNames()

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

clearFilter()

public TextSearch.Builder clearFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextSearch.Builder

clearOutputFields()

public TextSearch.Builder clearOutputFields()

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextSearch.Builder

clearSearchText()

public TextSearch.Builder clearSearchText()

Required. The query text.

string search_text = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

clearTopK()

public TextSearch.Builder clearTopK()

Optional. The number of results to return.

optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

getDataFieldNames(int index)

public String getDataFieldNames(int index)

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The dataFieldNames at the given index.

getDataFieldNamesBytes(int index)

public ByteString getDataFieldNamesBytes(int index)

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the dataFieldNames at the given index.

getDataFieldNamesCount()

public int getDataFieldNamesCount()

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of dataFieldNames.

getDataFieldNamesList()

public ProtocolStringList getDataFieldNamesList()

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ProtocolStringList	A list containing the dataFieldNames.

getDefaultInstanceForType()

public TextSearch getDefaultInstanceForType()

Returns
Type	Description
TextSearch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getFilter()

public Struct getFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The filter.

getFilterBuilder()

public Struct.Builder getFilterBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getFilterOrBuilder()

public StructOrBuilder getFilterOrBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getOutputFields()

public OutputFields getOutputFields()

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFields	The outputFields.

getOutputFieldsBuilder()

public OutputFields.Builder getOutputFieldsBuilder()

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFields.Builder

getOutputFieldsOrBuilder()

public OutputFieldsOrBuilder getOutputFieldsOrBuilder()

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFieldsOrBuilder

getSearchText()

public String getSearchText()

Required. The query text.

string search_text = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The searchText.

getSearchTextBytes()

public ByteString getSearchTextBytes()

Required. The query text.

string search_text = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for searchText.

getTopK()

public int getTopK()

Optional. The number of results to return.

optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The topK.

hasFilter()

public boolean hasFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the filter field is set.

hasOutputFields()

public boolean hasOutputFields()

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the outputFields field is set.

hasTopK()

public boolean hasTopK()

Optional. The number of results to return.

optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the topK field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFilter(Struct value)

public TextSearch.Builder mergeFilter(Struct value)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
TextSearch.Builder

mergeFrom(TextSearch other)

public TextSearch.Builder mergeFrom(TextSearch other)

Parameter
Name	Description
other	TextSearch

Returns
Type	Description
TextSearch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TextSearch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextSearch.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public TextSearch.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
TextSearch.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOutputFields(OutputFields value)

public TextSearch.Builder mergeOutputFields(OutputFields value)

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
TextSearch.Builder

setDataFieldNames(int index, String value)

public TextSearch.Builder setDataFieldNames(int index, String value)

Required. The data field names to search.

repeated string data_field_names = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int The index to set the value at.
value	String The dataFieldNames to set.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

setFilter(Struct value)

public TextSearch.Builder setFilter(Struct value)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
TextSearch.Builder

setFilter(Struct.Builder builderForValue)

public TextSearch.Builder setFilter(Struct.Builder builderForValue)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
TextSearch.Builder

setOutputFields(OutputFields value)

public TextSearch.Builder setOutputFields(OutputFields value)

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
TextSearch.Builder

setOutputFields(OutputFields.Builder builderForValue)

public TextSearch.Builder setOutputFields(OutputFields.Builder builderForValue)

Optional. The fields to return in the search results.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	OutputFields.Builder

Returns
Type	Description
TextSearch.Builder

setSearchText(String value)

public TextSearch.Builder setSearchText(String value)

Required. The query text.

string search_text = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The searchText to set.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

setSearchTextBytes(ByteString value)

public TextSearch.Builder setSearchTextBytes(ByteString value)

Required. The query text.

string search_text = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for searchText to set.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.

setTopK(int value)

public TextSearch.Builder setTopK(int value)

Optional. The number of results to return.

optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The topK to set.

Returns
Type	Description
TextSearch.Builder	This builder for chaining.