Package io.dingodb.common

Class Common.CreateIvfPqParam.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

io.dingodb.common.Common.CreateIvfPqParam.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.CreateIvfPqParamOrBuilder, Cloneable

Enclosing class:

Common.CreateIvfPqParam

public static final class Common.CreateIvfPqParam.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>
implements Common.CreateIvfPqParamOrBuilder

Protobuf type dingodb.pb.common.CreateIvfPqParam

Method Summary

Modifier and Type	Method	Description
Common.CreateIvfPqParam.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Common.CreateIvfPqParam	build()
Common.CreateIvfPqParam	buildPartial()
Common.CreateIvfPqParam.Builder	clear()
Common.CreateIvfPqParam.Builder	clearBucketInitSize()	Inverted list (IVF) bucket initialization size default 1000 optional
Common.CreateIvfPqParam.Builder	clearBucketMaxSize()	Inverted list (IVF) bucket maximum capacity default 1280000 optional
Common.CreateIvfPqParam.Builder	clearDimension()	dimensions required
Common.CreateIvfPqParam.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Common.CreateIvfPqParam.Builder	clearMetricType()	distance calculation method (L2 or InnerProduct) required
Common.CreateIvfPqParam.Builder	clearNbitsPerIdx()	bit number of sub cluster center.
Common.CreateIvfPqParam.Builder	clearNcentroids()	Number of cluster centers Default 2048 required
Common.CreateIvfPqParam.Builder	clearNsubvector()	PQ split sub-vector size default 64 required
Common.CreateIvfPqParam.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Common.CreateIvfPqParam.Builder	clone()
int	getBucketInitSize()	Inverted list (IVF) bucket initialization size default 1000 optional
int	getBucketMaxSize()	Inverted list (IVF) bucket maximum capacity default 1280000 optional
Common.CreateIvfPqParam	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getDimension()	dimensions required
Common.MetricType	getMetricType()	distance calculation method (L2 or InnerProduct) required
int	getMetricTypeValue()	distance calculation method (L2 or InnerProduct) required
int	getNbitsPerIdx()	bit number of sub cluster center.
int	getNcentroids()	Number of cluster centers Default 2048 required
int	getNsubvector()	PQ split sub-vector size default 64 required
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Common.CreateIvfPqParam.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Common.CreateIvfPqParam.Builder	mergeFrom(com.google.protobuf.Message other)
Common.CreateIvfPqParam.Builder	mergeFrom(Common.CreateIvfPqParam other)
final Common.CreateIvfPqParam.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Common.CreateIvfPqParam.Builder	setBucketInitSize(int value)	Inverted list (IVF) bucket initialization size default 1000 optional
Common.CreateIvfPqParam.Builder	setBucketMaxSize(int value)	Inverted list (IVF) bucket maximum capacity default 1280000 optional
Common.CreateIvfPqParam.Builder	setDimension(int value)	dimensions required
Common.CreateIvfPqParam.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Common.CreateIvfPqParam.Builder	setMetricType(Common.MetricType value)	distance calculation method (L2 or InnerProduct) required
Common.CreateIvfPqParam.Builder	setMetricTypeValue(int value)	distance calculation method (L2 or InnerProduct) required
Common.CreateIvfPqParam.Builder	setNbitsPerIdx(int value)	bit number of sub cluster center.
Common.CreateIvfPqParam.Builder	setNcentroids(int value)	Number of cluster centers Default 2048 required
Common.CreateIvfPqParam.Builder	setNsubvector(int value)	PQ split sub-vector size default 64 required
Common.CreateIvfPqParam.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
final Common.CreateIvfPqParam.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

clear

public Common.CreateIvfPqParam.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

getDefaultInstanceForType

public Common.CreateIvfPqParam getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Common.CreateIvfPqParam build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Common.CreateIvfPqParam buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Common.CreateIvfPqParam.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

setField

public Common.CreateIvfPqParam.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

clearField

public Common.CreateIvfPqParam.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

clearOneof

public Common.CreateIvfPqParam.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

setRepeatedField

public Common.CreateIvfPqParam.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

addRepeatedField

public Common.CreateIvfPqParam.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

mergeFrom

public Common.CreateIvfPqParam.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Common.CreateIvfPqParam.Builder>

mergeFrom

public Common.CreateIvfPqParam.Builder mergeFrom(Common.CreateIvfPqParam other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

mergeFrom

public Common.CreateIvfPqParam.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Common.CreateIvfPqParam.Builder>

Throws:

IOException

getDimension

public int getDimension()

 dimensions required
 

uint32 dimension = 1;

Specified by:

getDimension in interface Common.CreateIvfPqParamOrBuilder

Returns:

The dimension.

setDimension

public Common.CreateIvfPqParam.Builder setDimension(int value)

 dimensions required
 

uint32 dimension = 1;

Parameters:

value - The dimension to set.

Returns:

This builder for chaining.

clearDimension

public Common.CreateIvfPqParam.Builder clearDimension()

 dimensions required
 

uint32 dimension = 1;

Returns:

This builder for chaining.

getMetricTypeValue

public int getMetricTypeValue()

 distance calculation method (L2 or InnerProduct) required
 

.dingodb.pb.common.MetricType metric_type = 2;

Specified by:

getMetricTypeValue in interface Common.CreateIvfPqParamOrBuilder

Returns:

The enum numeric value on the wire for metricType.

setMetricTypeValue

public Common.CreateIvfPqParam.Builder setMetricTypeValue(int value)

 distance calculation method (L2 or InnerProduct) required
 

.dingodb.pb.common.MetricType metric_type = 2;

Parameters:

value - The enum numeric value on the wire for metricType to set.

Returns:

This builder for chaining.

getMetricType

public Common.MetricType getMetricType()

 distance calculation method (L2 or InnerProduct) required
 

.dingodb.pb.common.MetricType metric_type = 2;

Specified by:

getMetricType in interface Common.CreateIvfPqParamOrBuilder

Returns:

The metricType.

setMetricType

public Common.CreateIvfPqParam.Builder setMetricType(Common.MetricType value)

 distance calculation method (L2 or InnerProduct) required
 

.dingodb.pb.common.MetricType metric_type = 2;

Parameters:

value - The metricType to set.

Returns:

This builder for chaining.

clearMetricType

public Common.CreateIvfPqParam.Builder clearMetricType()

 distance calculation method (L2 or InnerProduct) required
 

.dingodb.pb.common.MetricType metric_type = 2;

Returns:

This builder for chaining.

getNcentroids

public int getNcentroids()

 Number of cluster centers Default 2048 required
 

int32 ncentroids = 3;

Specified by:

getNcentroids in interface Common.CreateIvfPqParamOrBuilder

Returns:

The ncentroids.

setNcentroids

public Common.CreateIvfPqParam.Builder setNcentroids(int value)

 Number of cluster centers Default 2048 required
 

int32 ncentroids = 3;

Parameters:

value - The ncentroids to set.

Returns:

This builder for chaining.

clearNcentroids

public Common.CreateIvfPqParam.Builder clearNcentroids()

 Number of cluster centers Default 2048 required
 

int32 ncentroids = 3;

Returns:

This builder for chaining.

getNsubvector

public int getNsubvector()

 PQ split sub-vector size default 64 required
 

int32 nsubvector = 4;

Specified by:

getNsubvector in interface Common.CreateIvfPqParamOrBuilder

Returns:

The nsubvector.

setNsubvector

public Common.CreateIvfPqParam.Builder setNsubvector(int value)

 PQ split sub-vector size default 64 required
 

int32 nsubvector = 4;

Parameters:

value - The nsubvector to set.

Returns:

This builder for chaining.

clearNsubvector

public Common.CreateIvfPqParam.Builder clearNsubvector()

 PQ split sub-vector size default 64 required
 

int32 nsubvector = 4;

Returns:

This builder for chaining.

getBucketInitSize

public int getBucketInitSize()

 Inverted list (IVF) bucket initialization size default 1000 optional
 

int32 bucket_init_size = 5;

Specified by:

getBucketInitSize in interface Common.CreateIvfPqParamOrBuilder

Returns:

The bucketInitSize.

setBucketInitSize

public Common.CreateIvfPqParam.Builder setBucketInitSize(int value)

 Inverted list (IVF) bucket initialization size default 1000 optional
 

int32 bucket_init_size = 5;

Parameters:

value - The bucketInitSize to set.

Returns:

This builder for chaining.

clearBucketInitSize

public Common.CreateIvfPqParam.Builder clearBucketInitSize()

 Inverted list (IVF) bucket initialization size default 1000 optional
 

int32 bucket_init_size = 5;

Returns:

This builder for chaining.

getBucketMaxSize

public int getBucketMaxSize()

 Inverted list (IVF) bucket maximum capacity default 1280000 optional
 

int32 bucket_max_size = 6;

Specified by:

getBucketMaxSize in interface Common.CreateIvfPqParamOrBuilder

Returns:

The bucketMaxSize.

setBucketMaxSize

public Common.CreateIvfPqParam.Builder setBucketMaxSize(int value)

 Inverted list (IVF) bucket maximum capacity default 1280000 optional
 

int32 bucket_max_size = 6;

Parameters:

value - The bucketMaxSize to set.

Returns:

This builder for chaining.

clearBucketMaxSize

public Common.CreateIvfPqParam.Builder clearBucketMaxSize()

 Inverted list (IVF) bucket maximum capacity default 1280000 optional
 

int32 bucket_max_size = 6;

Returns:

This builder for chaining.

getNbitsPerIdx

public int getNbitsPerIdx()

 bit number of sub cluster center. default 8 required.  means 256.
 

int32 nbits_per_idx = 7;

Specified by:

getNbitsPerIdx in interface Common.CreateIvfPqParamOrBuilder

Returns:

The nbitsPerIdx.

setNbitsPerIdx

public Common.CreateIvfPqParam.Builder setNbitsPerIdx(int value)

 bit number of sub cluster center. default 8 required.  means 256.
 

int32 nbits_per_idx = 7;

Parameters:

value - The nbitsPerIdx to set.

Returns:

This builder for chaining.

clearNbitsPerIdx

public Common.CreateIvfPqParam.Builder clearNbitsPerIdx()

 bit number of sub cluster center. default 8 required.  means 256.
 

int32 nbits_per_idx = 7;

Returns:

This builder for chaining.

setUnknownFields

public final Common.CreateIvfPqParam.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>

mergeUnknownFields

public final Common.CreateIvfPqParam.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateIvfPqParam.Builder>