public static final class SearchHint.IndexHint.DenseScannParams.Builder extends GeneratedMessage.Builder<SearchHint.IndexHint.DenseScannParams.Builder> implements SearchHint.IndexHint.DenseScannParamsOrBuilderParameters for dense ScaNN.
Protobuf type
google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchHint.IndexHint.DenseScannParams.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchHint.IndexHint.DenseScannParams build()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams |
|
buildPartial()
public SearchHint.IndexHint.DenseScannParams buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams |
|
clear()
public SearchHint.IndexHint.DenseScannParams.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
|
clearInitialCandidateCount()
public SearchHint.IndexHint.DenseScannParams.Builder clearInitialCandidateCount() Optional. The number of initial candidates. Must be a positive integer
(> 0). Not supported for STORAGE_OPTIMIZED indexes. Cannot be set
together with target_recall.
int32 initial_candidate_count = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
This builder for chaining. |
clearSearchLeavesPct()
public SearchHint.IndexHint.DenseScannParams.Builder clearSearchLeavesPct() Optional. Dense ANN param overrides to control recall and latency.
The percentage of leaves to search, in the range [0, 100].
Not supported for STORAGE_OPTIMIZED indexes.
Cannot be set together with target_recall.
int32 search_leaves_pct = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
This builder for chaining. |
clearTargetRecall()
public SearchHint.IndexHint.DenseScannParams.Builder clearTargetRecall()Optional. The target recall for the search. Must be a double in the range [0, 1]. While the search aims to achieve this level of recall, it is not guaranteed.
optional double target_recall = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public SearchHint.IndexHint.DenseScannParams getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getInitialCandidateCount()
public int getInitialCandidateCount() Optional. The number of initial candidates. Must be a positive integer
(> 0). Not supported for STORAGE_OPTIMIZED indexes. Cannot be set
together with target_recall.
int32 initial_candidate_count = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The initialCandidateCount. |
getSearchLeavesPct()
public int getSearchLeavesPct() Optional. Dense ANN param overrides to control recall and latency.
The percentage of leaves to search, in the range [0, 100].
Not supported for STORAGE_OPTIMIZED indexes.
Cannot be set together with target_recall.
int32 search_leaves_pct = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The searchLeavesPct. |
getTargetRecall()
public double getTargetRecall()Optional. The target recall for the search. Must be a double in the range [0, 1]. While the search aims to achieve this level of recall, it is not guaranteed.
optional double target_recall = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
double |
The targetRecall. |
hasTargetRecall()
public boolean hasTargetRecall()Optional. The target recall for the search. Must be a double in the range [0, 1]. While the search aims to achieve this level of recall, it is not guaranteed.
optional double target_recall = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the targetRecall field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchHint.IndexHint.DenseScannParams other)
public SearchHint.IndexHint.DenseScannParams.Builder mergeFrom(SearchHint.IndexHint.DenseScannParams other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchHint.IndexHint.DenseScannParams |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchHint.IndexHint.DenseScannParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchHint.IndexHint.DenseScannParams.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
|
setInitialCandidateCount(int value)
public SearchHint.IndexHint.DenseScannParams.Builder setInitialCandidateCount(int value) Optional. The number of initial candidates. Must be a positive integer
(> 0). Not supported for STORAGE_OPTIMIZED indexes. Cannot be set
together with target_recall.
int32 initial_candidate_count = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe initialCandidateCount to set. |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
This builder for chaining. |
setSearchLeavesPct(int value)
public SearchHint.IndexHint.DenseScannParams.Builder setSearchLeavesPct(int value) Optional. Dense ANN param overrides to control recall and latency.
The percentage of leaves to search, in the range [0, 100].
Not supported for STORAGE_OPTIMIZED indexes.
Cannot be set together with target_recall.
int32 search_leaves_pct = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe searchLeavesPct to set. |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
This builder for chaining. |
setTargetRecall(double value)
public SearchHint.IndexHint.DenseScannParams.Builder setTargetRecall(double value)Optional. The target recall for the search. Must be a double in the range [0, 1]. While the search aims to achieve this level of recall, it is not guaranteed.
optional double target_recall = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe targetRecall to set. |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
This builder for chaining. |