public static final class SearchResponseMetadata.Builder extends GeneratedMessage.Builder<SearchResponseMetadata.Builder> implements SearchResponseMetadataOrBuilderMetadata about the search execution.
Protobuf type google.cloud.vectorsearch.v1beta.SearchResponseMetadata
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchResponseMetadata.BuilderImplements
SearchResponseMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllWarnings(Iterable<? extends Status> values)
public SearchResponseMetadata.Builder addAllWarnings(Iterable<? extends Status> values)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 |
values |
Iterable<? extends com.google.rpc.Status> |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
addWarnings(Status value)
public SearchResponseMetadata.Builder addWarnings(Status value)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 |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
addWarnings(Status.Builder builderForValue)
public SearchResponseMetadata.Builder addWarnings(Status.Builder builderForValue)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 |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
addWarnings(int index, Status value)
public SearchResponseMetadata.Builder addWarnings(int index, Status value)Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
addWarnings(int index, Status.Builder builderForValue)
public SearchResponseMetadata.Builder addWarnings(int index, Status.Builder builderForValue)Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
addWarningsBuilder()
public Status.Builder addWarningsBuilder()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 |
com.google.rpc.Status.Builder |
|
addWarningsBuilder(int index)
public Status.Builder addWarningsBuilder(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.Builder |
|
build()
public SearchResponseMetadata build()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata |
|
buildPartial()
public SearchResponseMetadata buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata |
|
clear()
public SearchResponseMetadata.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
clearIndexType()
public SearchResponseMetadata.Builder clearIndexType()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
clearUsedIndex()
public SearchResponseMetadata.Builder clearUsedIndex()Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
clearUsedKnn()
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];
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
This builder for chaining. |
clearWarnings()
public SearchResponseMetadata.Builder clearWarnings()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 |
SearchResponseMetadata.Builder |
|
getDefaultInstanceForType()
public SearchResponseMetadata getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIndexTypeCase()
public SearchResponseMetadata.IndexTypeCase getIndexTypeCase()| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.IndexTypeCase |
|
getUsedIndex()
public 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. |
getUsedIndexBuilder()
public SearchResponseMetadata.IndexInfo.Builder getUsedIndexBuilder()Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.IndexInfo.Builder |
|
getUsedIndexOrBuilder()
public 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 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 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 |
|
getWarningsBuilder(int index)
public Status.Builder getWarningsBuilder(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.Builder |
|
getWarningsBuilderList()
public List<Status.Builder> getWarningsBuilderList()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.Builder> |
|
getWarningsCount()
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 |
|
getWarningsList()
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> |
|
getWarningsOrBuilder(int index)
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 |
|
getWarningsOrBuilderList()
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> |
|
hasUsedIndex()
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. |
hasUsedKnn()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchResponseMetadata other)
public SearchResponseMetadata.Builder mergeFrom(SearchResponseMetadata other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResponseMetadata |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponseMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchResponseMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
mergeUsedIndex(SearchResponseMetadata.IndexInfo value)
public SearchResponseMetadata.Builder mergeUsedIndex(SearchResponseMetadata.IndexInfo value)Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponseMetadata.IndexInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
removeWarnings(int index)
public SearchResponseMetadata.Builder removeWarnings(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 |
SearchResponseMetadata.Builder |
|
setUsedIndex(SearchResponseMetadata.IndexInfo value)
public SearchResponseMetadata.Builder setUsedIndex(SearchResponseMetadata.IndexInfo value)Indicates that the search used a particular index.
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponseMetadata.IndexInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
setUsedIndex(SearchResponseMetadata.IndexInfo.Builder builderForValue)
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponseMetadata.IndexInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
setUsedKnn(boolean value)
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 |
booleanThe usedKnn to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
This builder for chaining. |
setWarnings(int index, Status value)
public SearchResponseMetadata.Builder setWarnings(int index, Status value)Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|
setWarnings(int index, Status.Builder builderForValue)
public SearchResponseMetadata.Builder setWarnings(int index, Status.Builder builderForValue)Output only. Warnings or non-fatal errors that occurred during execution.
repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponseMetadata.Builder |
|