Interface SearchDataObjectsResponseOrBuilder (0.1.0)

public interface SearchDataObjectsResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getNextPageToken()

public abstract String getNextPageToken()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public abstract ByteString getNextPageTokenBytes()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for nextPageToken.

getResults(int index)

public abstract SearchResult getResults(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SearchResult

getResultsCount()

public abstract int getResultsCount()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getResultsList()

public abstract List<SearchResult> getResultsList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<SearchResult>

getResultsOrBuilder(int index)

public abstract SearchResultOrBuilder getResultsOrBuilder(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SearchResultOrBuilder

getResultsOrBuilderList()

public abstract List<? extends SearchResultOrBuilder> getResultsOrBuilderList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getSearchResponseMetadata()

public abstract SearchResponseMetadata getSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchResponseMetadata

The searchResponseMetadata.

getSearchResponseMetadataOrBuilder()

public abstract SearchResponseMetadataOrBuilder getSearchResponseMetadataOrBuilder()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchResponseMetadataOrBuilder

hasSearchResponseMetadata()

public abstract boolean hasSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the searchResponseMetadata field is set.