Class SearchHint.IndexHint.DenseScannParams.Builder (0.21.0)

public static final class SearchHint.IndexHint.DenseScannParams.Builder extends GeneratedMessage.Builder<SearchHint.IndexHint.DenseScannParams.Builder> implements SearchHint.IndexHint.DenseScannParamsOrBuilder

Parameters for dense ScaNN.

Protobuf type google.cloud.vectorsearch.v1.SearchHint.IndexHint.DenseScannParams

Static 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
Overrides

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
Overrides

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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
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
Overrides

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 double

The targetRecall to set.

Returns
Type Description
SearchHint.IndexHint.DenseScannParams.Builder

This builder for chaining.