Class SearchResponseMetadata (0.1.0)
public final class SearchResponseMetadata extends GeneratedMessageV3 implements SearchResponseMetadataOrBuilder
Metadata about the search execution.
Protobuf type google.cloud.vectorsearch.v1beta.SearchResponseMetadata
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
public static final int USED_INDEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int USED_KNN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static SearchResponseMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static SearchResponseMetadata.Builder newBuilder()
public static SearchResponseMetadata.Builder newBuilder(SearchResponseMetadata prototype)
public static SearchResponseMetadata parseDelimitedFrom(InputStream input)
public static SearchResponseMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponseMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static SearchResponseMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponseMetadata parseFrom(ByteString data)
public static SearchResponseMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponseMetadata parseFrom(CodedInputStream input)
public static SearchResponseMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponseMetadata parseFrom(InputStream input)
public static SearchResponseMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponseMetadata parseFrom(ByteBuffer data)
public static SearchResponseMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<SearchResponseMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public SearchResponseMetadata getDefaultInstanceForType()
public SearchResponseMetadata.IndexTypeCase getIndexTypeCase()
public Parser<SearchResponseMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public SearchResponseMetadata.IndexInfo getUsedIndex()
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public SearchResponseMetadata.IndexInfoOrBuilder getUsedIndexOrBuilder()
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public boolean getUsedKnn()
Output only. If true, the search used the system's default
K-Nearest Neighbor (KNN) index engine.
bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The usedKnn.
|
public boolean hasUsedIndex()
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Returns |
| Type |
Description |
boolean |
Whether the usedIndex field is set.
|
public boolean hasUsedKnn()
Output only. If true, the search used the system's default
K-Nearest Neighbor (KNN) index engine.
bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the usedKnn field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchResponseMetadata.Builder newBuilderForType()
protected SearchResponseMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public SearchResponseMetadata.Builder toBuilder()
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."],[],[]]
