Class TextSearch (0.1.0)
public final class TextSearch extends GeneratedMessageV3 implements TextSearchOrBuilder
Defines a text search operation.
Protobuf type google.cloud.vectorsearch.v1beta.TextSearch
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATA_FIELD_NAMES_FIELD_NUMBER
public static final int DATA_FIELD_NAMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_FIELDS_FIELD_NUMBER
public static final int OUTPUT_FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SEARCH_TEXT_FIELD_NUMBER
public static final int SEARCH_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOP_K_FIELD_NUMBER
public static final int TOP_K_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TextSearch getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TextSearch.Builder newBuilder()
newBuilder(TextSearch prototype)
public static TextSearch.Builder newBuilder(TextSearch prototype)
parseDelimitedFrom(InputStream input)
public static TextSearch parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TextSearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TextSearch parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TextSearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TextSearch parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TextSearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static TextSearch parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TextSearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static TextSearch parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TextSearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TextSearch parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TextSearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TextSearch> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
getDefaultInstanceForType()
public TextSearch getDefaultInstanceForType()
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];
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];
getParserForType()
public Parser<TextSearch> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTopK()
Optional. The number of results to return.
optional int32 top_k = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The topK.
|
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()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TextSearch.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TextSearch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TextSearch.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
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-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
