Class SearchDataObjectsResponse (0.1.0)
public final class SearchDataObjectsResponse extends GeneratedMessageV3 implements SearchDataObjectsResponseOrBuilder
Response for a search request.
Protobuf type google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse
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
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SEARCH_RESPONSE_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchDataObjectsResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchDataObjectsResponse.Builder newBuilder()
newBuilder(SearchDataObjectsResponse prototype)
public static SearchDataObjectsResponse.Builder newBuilder(SearchDataObjectsResponse prototype)
public static SearchDataObjectsResponse parseDelimitedFrom(InputStream input)
public static SearchDataObjectsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchDataObjectsResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchDataObjectsResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsResponse parseFrom(CodedInputStream input)
public static SearchDataObjectsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsResponse parseFrom(InputStream input)
public static SearchDataObjectsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchDataObjectsResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchDataObjectsResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchDataObjectsResponse getDefaultInstanceForType()
getNextPageToken()
public 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 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.
|
getParserForType()
public Parser<SearchDataObjectsResponse> getParserForType()
Overrides
getResults(int index)
public 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
|
getResultsCount()
public 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 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];
getResultsOrBuilder(int index)
public 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
|
getResultsOrBuilderList()
public 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> |
|
public SearchResponseMetadata getSearchResponseMetadata()
Output only. Metadata about the search execution.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public SearchResponseMetadataOrBuilder getSearchResponseMetadataOrBuilder()
Output only. Metadata about the search execution.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchDataObjectsResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchDataObjectsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchDataObjectsResponse.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."],[],[]]
