public interface SearchResponseMetadataOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getIndexTypeCase()
public abstract SearchResponseMetadata.IndexTypeCase getIndexTypeCase()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.IndexTypeCase |
|
getUsedIndex()
public abstract SearchResponseMetadata.IndexInfo getUsedIndex()Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.IndexInfo |
The usedIndex. |
getUsedIndexOrBuilder()
public abstract SearchResponseMetadata.IndexInfoOrBuilder getUsedIndexOrBuilder()Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.IndexInfoOrBuilder |
|
getUsedKnn()
public abstract 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. |
getWarnings(int index)
public abstract 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 |
|
getWarningsCount()
public abstract 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 |
|
getWarningsList()
public abstract 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> |
|
getWarningsOrBuilder(int index)
public abstract 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 |
|
getWarningsOrBuilderList()
public abstract 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> |
|
hasUsedIndex()
public abstract 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. |
hasUsedKnn()
public abstract 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. |