Class SearchHint.IndexHint.DenseScannParams.Builder (0.8.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.v1beta.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

clearInitialCandidateCount()

public SearchHint.IndexHint.DenseScannParams.Builder clearInitialCandidateCount()

Optional. The number of initial candidates. Must be a positive integer (> 0).

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].

int32 search_leaves_pct = 1 [(.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

getInitialCandidateCount()

public int getInitialCandidateCount()

Optional. The number of initial candidates. Must be a positive integer (> 0).

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].

int32 search_leaves_pct = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The searchLeavesPct.

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

setInitialCandidateCount(int value)

public SearchHint.IndexHint.DenseScannParams.Builder setInitialCandidateCount(int value)

Optional. The number of initial candidates. Must be a positive integer (> 0).

int32 initial_candidate_count = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The 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].

int32 search_leaves_pct = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The searchLeavesPct to set.

Returns
Type Description
SearchHint.IndexHint.DenseScannParams.Builder

This builder for chaining.