Interface TextSearchOrBuilder (0.1.0)

public interface TextSearchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataFieldNames(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> getDataFieldNamesList()

Required. The data field names to search.

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

Returns
Type	Description
List<String>	A list containing the dataFieldNames.

getOutputFields()

public abstract 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.

getOutputFieldsOrBuilder()

public abstract 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 abstract String getSearchText()

Required. The query text.

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

Returns
Type	Description
String	The searchText.

getSearchTextBytes()

public abstract 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 abstract 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.

hasOutputFields()

public abstract 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 abstract 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.