Interface BatchSearchDataObjectsRequestOrBuilder (0.1.0)

public interface BatchSearchDataObjectsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCombine()

public abstract BatchSearchDataObjectsRequest.CombineResultsOptions getCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BatchSearchDataObjectsRequest.CombineResultsOptions

The combine.

getCombineOrBuilder()

public abstract BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder getCombineOrBuilder()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder

getParent()

public abstract String getParent()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getSearches(int index)

public abstract Search getSearches(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Search

getSearchesCount()

public abstract int getSearchesCount()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getSearchesList()

public abstract List<Search> getSearchesList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Search>

getSearchesOrBuilder(int index)

public abstract SearchOrBuilder getSearchesOrBuilder(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SearchOrBuilder

getSearchesOrBuilderList()

public abstract List<? extends SearchOrBuilder> getSearchesOrBuilderList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.vectorsearch.v1beta.SearchOrBuilder>

hasCombine()

public abstract boolean hasCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the combine field is set.