Class SearchResponseMetadata.Builder (0.1.0)
public static final class SearchResponseMetadata.Builder extends GeneratedMessageV3.Builder<SearchResponseMetadata.Builder> implements SearchResponseMetadataOrBuilder
Metadata about the search execution.
Protobuf type google.cloud.vectorsearch.v1beta.SearchResponseMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public SearchResponseMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public SearchResponseMetadata build()
public SearchResponseMetadata buildPartial()
public SearchResponseMetadata.Builder clear()
Overrides
public SearchResponseMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public SearchResponseMetadata.Builder clearIndexType()
public SearchResponseMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public SearchResponseMetadata.Builder clearUsedIndex()
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public SearchResponseMetadata.Builder clearUsedKnn()
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];
public SearchResponseMetadata.Builder clone()
Overrides
public SearchResponseMetadata getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
public SearchResponseMetadata.IndexTypeCase getIndexTypeCase()
public SearchResponseMetadata.IndexInfo getUsedIndex()
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public SearchResponseMetadata.IndexInfo.Builder getUsedIndexBuilder()
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.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchResponseMetadata.Builder mergeFrom(SearchResponseMetadata other)
public SearchResponseMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public SearchResponseMetadata.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public final SearchResponseMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public SearchResponseMetadata.Builder mergeUsedIndex(SearchResponseMetadata.IndexInfo value)
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public SearchResponseMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public SearchResponseMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public final SearchResponseMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
public SearchResponseMetadata.Builder setUsedIndex(SearchResponseMetadata.IndexInfo value)
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public SearchResponseMetadata.Builder setUsedIndex(SearchResponseMetadata.IndexInfo.Builder builderForValue)
Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
public SearchResponseMetadata.Builder setUsedKnn(boolean value)
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];
| Parameter |
| Name |
Description |
value |
boolean
The usedKnn to set.
|
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."],[],[]]
