public final class SearchResponseMetadata extends GeneratedMessage implements SearchResponseMetadataOrBuilder
Metadata about the search execution.
Protobuf type google.cloud.vectorsearch.v1beta.SearchResponseMetadata
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,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 |
|
public static final int WARNINGS_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 Status getWarnings(int index)
Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
com.google.rpc.Status |
|
public int getWarningsCount()
Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
public List<Status> getWarningsList()
Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<com.google.rpc.Status> |
|
public StatusOrBuilder getWarningsOrBuilder(int index)
Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
com.google.rpc.StatusOrBuilder |
|
public List<? extends StatusOrBuilder> getWarningsOrBuilderList()
Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.rpc.StatusOrBuilder> |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchResponseMetadata.Builder newBuilderForType()
protected SearchResponseMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public SearchResponseMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
