Class TextQuery (0.21.0)

0.21.0 (latest) 0.17.0 0.16.0 0.15.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

public final class TextQuery extends GeneratedMessage implements TextQueryOrBuilder

A leaf-level text query targeting one or more data fields. When multiple fields are specified, this is equivalent to combining per-field matches with an OR operator (i.e. the query matches if the text is found in any of the listed fields).

Protobuf type google.cloud.vectorsearch.v1beta.TextQuery

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > TextQuery

Implements

TextQueryOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

Field Value
Type	Description
int

MATCH_TYPE_FIELD_NUMBER

public static final int MATCH_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_ENHANCEMENT_FIELD_NUMBER

public static final int QUERY_ENHANCEMENT_FIELD_NUMBER

Field Value
Type	Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static TextQuery getDefaultInstance()

Returns
Type	Description
TextQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static TextQuery.Builder newBuilder()

Returns
Type	Description
TextQuery.Builder

newBuilder(TextQuery prototype)

public static TextQuery.Builder newBuilder(TextQuery prototype)

Parameter
Name	Description
prototype	TextQuery

Returns
Type	Description
TextQuery.Builder

parseDelimitedFrom(InputStream input)

public static TextQuery parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TextQuery

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextQuery

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static TextQuery parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
TextQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TextQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TextQuery parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
TextQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TextQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TextQuery parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
TextQuery

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TextQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextQuery

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static TextQuery parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TextQuery

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextQuery

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static TextQuery parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
TextQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TextQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TextQuery> parser()

Returns
Type	Description
Parser<TextQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TextQuery getDefaultInstanceForType()

Returns
Type	Description
TextQuery

getFields(int index)

public String getFields(int index)

Required. The data fields to search against.

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

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

Returns
Type	Description
String	The fields at the given index.

getFieldsBytes(int index)

public ByteString getFieldsBytes(int index)

Required. The data fields to search against.

repeated string fields = 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 fields at the given index.

getFieldsCount()

public int getFieldsCount()

Required. The data fields to search against.

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

Returns
Type	Description
int	The count of fields.

getFieldsList()

public ProtocolStringList getFieldsList()

Required. The data fields to search against.

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

Returns
Type	Description
ProtocolStringList	A list containing the fields.

getMatchType()

public TextQuery.MatchType getMatchType()

Optional. The matching strategy to apply for this query. If unset, defaults to STANDARD.

.google.cloud.vectorsearch.v1beta.TextQuery.MatchType match_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextQuery.MatchType	The matchType.

getMatchTypeValue()

public int getMatchTypeValue()

Optional. The matching strategy to apply for this query. If unset, defaults to STANDARD.

.google.cloud.vectorsearch.v1beta.TextQuery.MatchType match_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for matchType.

getParserForType()

public Parser<TextQuery> getParserForType()

Returns
Type	Description
Parser<TextQuery>

Overrides

GeneratedMessage.getParserForType()

getQueryEnhancement()

public QueryEnhancement getQueryEnhancement()

Optional. The query enhancement settings to apply for this query.

.google.cloud.vectorsearch.v1beta.QueryEnhancement query_enhancement = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryEnhancement	The queryEnhancement.

getQueryEnhancementOrBuilder()

public QueryEnhancementOrBuilder getQueryEnhancementOrBuilder()

Optional. The query enhancement settings to apply for this query.

.google.cloud.vectorsearch.v1beta.QueryEnhancement query_enhancement = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryEnhancementOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getText()

public String getText()

Required. The text to search for.

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

Returns
Type	Description
String	The text.

getTextBytes()

public ByteString getTextBytes()

Required. The text to search for.

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

Returns
Type	Description
ByteString	The bytes for text.

hasQueryEnhancement()

public boolean hasQueryEnhancement()

Optional. The query enhancement settings to apply for this query.

.google.cloud.vectorsearch.v1beta.QueryEnhancement query_enhancement = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the queryEnhancement field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public TextQuery.Builder newBuilderForType()

Returns
Type	Description
TextQuery.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected TextQuery.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
TextQuery.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public TextQuery.Builder toBuilder()

Returns
Type	Description
TextQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException