Package io.dingodb.common

Class Common.CreateDiskAnnParam.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateDiskAnnParam.Builder>
io.dingodb.common.Common.CreateDiskAnnParam.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.CreateDiskAnnParamOrBuilder, Cloneable
Enclosing class:
Common.CreateDiskAnnParam
public static final class Common.CreateDiskAnnParam.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Common.CreateDiskAnnParam.Builder> implements Common.CreateDiskAnnParamOrBuilder
Protobuf type dingodb.pb.common.CreateDiskAnnParam

  • 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.CreateDiskAnnParam.Builder>

    • clear

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • getDefaultInstanceForType

      public Common.CreateDiskAnnParam getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Common.CreateDiskAnnParam build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Common.CreateDiskAnnParam buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • setField

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • clearField

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • clearOneof

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • setRepeatedField

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • addRepeatedField

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • mergeFrom

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • mergeFrom

      public Common.CreateDiskAnnParam.Builder mergeFrom(Common.CreateDiskAnnParam 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.CreateDiskAnnParam.Builder>

    • mergeFrom

      public Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>
      Throws:
      IOException

    • getDimension

      public int getDimension()
       The number of dimensions in the vector data. required
      uint32 dimension = 1;
      Specified by:
      getDimension in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The dimension.

    • setDimension

      public Common.CreateDiskAnnParam.Builder setDimension(int value)
       The number of dimensions in the vector data. required
      uint32 dimension = 1;
      Parameters:
      value - The dimension to set.
      Returns:
      This builder for chaining.

    • clearDimension

      public Common.CreateDiskAnnParam.Builder clearDimension()
       The number of dimensions in the vector data. required
      uint32 dimension = 1;
      Returns:
      This builder for chaining.

    • getMetricTypeValue

      public int getMetricTypeValue()
       distance calculation method (L2 or InnerProduct) required
 The distance calculation method to be used for the index.
      .dingodb.pb.common.MetricType metric_type = 2;
      Specified by:
      getMetricTypeValue in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The enum numeric value on the wire for metricType.

    • setMetricTypeValue

      public Common.CreateDiskAnnParam.Builder setMetricTypeValue(int value)
       distance calculation method (L2 or InnerProduct) required
 The distance calculation method to be used for the index.
      .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
 The distance calculation method to be used for the index.
      .dingodb.pb.common.MetricType metric_type = 2;
      Specified by:
      getMetricType in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The metricType.

    • setMetricType

      public Common.CreateDiskAnnParam.Builder setMetricType(Common.MetricType value)
       distance calculation method (L2 or InnerProduct) required
 The distance calculation method to be used for the index.
      .dingodb.pb.common.MetricType metric_type = 2;
      Parameters:
      value - The metricType to set.
      Returns:
      This builder for chaining.

    • clearMetricType

      public Common.CreateDiskAnnParam.Builder clearMetricType()
       distance calculation method (L2 or InnerProduct) required
 The distance calculation method to be used for the index.
      .dingodb.pb.common.MetricType metric_type = 2;
      Returns:
      This builder for chaining.

    • getValueTypeValue

      public int getValueTypeValue()
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Specified by:
      getValueTypeValue in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The enum numeric value on the wire for valueType.

    • setValueTypeValue

      public Common.CreateDiskAnnParam.Builder setValueTypeValue(int value)
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Parameters:
      value - The enum numeric value on the wire for valueType to set.
      Returns:
      This builder for chaining.

    • getValueType

      public Common.ValueType getValueType()
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Specified by:
      getValueType in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The valueType.

    • setValueType

      public Common.CreateDiskAnnParam.Builder setValueType(Common.ValueType value)
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Parameters:
      value - The valueType to set.
      Returns:
      This builder for chaining.

    • clearValueType

      public Common.CreateDiskAnnParam.Builder clearValueType()
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Returns:
      This builder for chaining.

    • getMaxDegree

      public int getMaxDegree()
       the degree of the graph index, typically between 60 and 150.
 Larger max_degree will result in larger indices and longer indexing times, but better search quality.
 (default is 64) . R . required
      uint32 max_degree = 4;
      Specified by:
      getMaxDegree in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The maxDegree.

    • setMaxDegree

      public Common.CreateDiskAnnParam.Builder setMaxDegree(int value)
       the degree of the graph index, typically between 60 and 150.
 Larger max_degree will result in larger indices and longer indexing times, but better search quality.
 (default is 64) . R . required
      uint32 max_degree = 4;
      Parameters:
      value - The maxDegree to set.
      Returns:
      This builder for chaining.

    • clearMaxDegree

      public Common.CreateDiskAnnParam.Builder clearMaxDegree()
       the degree of the graph index, typically between 60 and 150.
 Larger max_degree will result in larger indices and longer indexing times, but better search quality.
 (default is 64) . R . required
      uint32 max_degree = 4;
      Returns:
      This builder for chaining.

    • getSearchListSize

      public int getSearchListSize()
       the size of search list during index build. Typical values are between 75 to 200.
 Larger values will take more time to build but result in indices that provide higher recall for the same search
 complexity. Use a value for search_list_size value that is at least the value of max_degree unless you need to
 build indices really quickly and can somewhat compromise on quality. (default is 100) . L . required
      uint32 search_list_size = 5;
      Specified by:
      getSearchListSize in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The searchListSize.

    • setSearchListSize

      public Common.CreateDiskAnnParam.Builder setSearchListSize(int value)
       the size of search list during index build. Typical values are between 75 to 200.
 Larger values will take more time to build but result in indices that provide higher recall for the same search
 complexity. Use a value for search_list_size value that is at least the value of max_degree unless you need to
 build indices really quickly and can somewhat compromise on quality. (default is 100) . L . required
      uint32 search_list_size = 5;
      Parameters:
      value - The searchListSize to set.
      Returns:
      This builder for chaining.

    • clearSearchListSize

      public Common.CreateDiskAnnParam.Builder clearSearchListSize()
       the size of search list during index build. Typical values are between 75 to 200.
 Larger values will take more time to build but result in indices that provide higher recall for the same search
 complexity. Use a value for search_list_size value that is at least the value of max_degree unless you need to
 build indices really quickly and can somewhat compromise on quality. (default is 100) . L . required
      uint32 search_list_size = 5;
      Returns:
      This builder for chaining.

    • getQd

      public int getQd()
       Quantized Dimension for compression. default is 0. optional
      uint32 qd = 6;
      Specified by:
      getQd in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The qd.

    • setQd

      public Common.CreateDiskAnnParam.Builder setQd(int value)
       Quantized Dimension for compression. default is 0. optional
      uint32 qd = 6;
      Parameters:
      value - The qd to set.
      Returns:
      This builder for chaining.

    • clearQd

      public Common.CreateDiskAnnParam.Builder clearQd()
       Quantized Dimension for compression. default is 0. optional
      uint32 qd = 6;
      Returns:
      This builder for chaining.

    • getCodebookPrefix

      public String getCodebookPrefix()
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Specified by:
      getCodebookPrefix in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The codebookPrefix.

    • getCodebookPrefixBytes

      public com.google.protobuf.ByteString getCodebookPrefixBytes()
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Specified by:
      getCodebookPrefixBytes in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The bytes for codebookPrefix.

    • setCodebookPrefix

      public Common.CreateDiskAnnParam.Builder setCodebookPrefix(String value)
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Parameters:
      value - The codebookPrefix to set.
      Returns:
      This builder for chaining.

    • clearCodebookPrefix

      public Common.CreateDiskAnnParam.Builder clearCodebookPrefix()
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Returns:
      This builder for chaining.

    • setCodebookPrefixBytes

      public Common.CreateDiskAnnParam.Builder setCodebookPrefixBytes(com.google.protobuf.ByteString value)
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Parameters:
      value - The bytes for codebookPrefix to set.
      Returns:
      This builder for chaining.

    • getPqDiskBytes

      public int getPqDiskBytes()
       Number of bytes to which vectors should be compressed "
 "on SSD; 0 for no compression. default is 0. optional
      uint32 pq_disk_bytes = 8;
      Specified by:
      getPqDiskBytes in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The pqDiskBytes.

    • setPqDiskBytes

      public Common.CreateDiskAnnParam.Builder setPqDiskBytes(int value)
       Number of bytes to which vectors should be compressed "
 "on SSD; 0 for no compression. default is 0. optional
      uint32 pq_disk_bytes = 8;
      Parameters:
      value - The pqDiskBytes to set.
      Returns:
      This builder for chaining.

    • clearPqDiskBytes

      public Common.CreateDiskAnnParam.Builder clearPqDiskBytes()
       Number of bytes to which vectors should be compressed "
 "on SSD; 0 for no compression. default is 0. optional
      uint32 pq_disk_bytes = 8;
      Returns:
      This builder for chaining.

    • getAppendReorderData

      public boolean getAppendReorderData()
       Include full precision data in the index. Use only in "
 "conjuction with compressed data on SSD. default is false. optional
      bool append_reorder_data = 9;
      Specified by:
      getAppendReorderData in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The appendReorderData.

    • setAppendReorderData

      public Common.CreateDiskAnnParam.Builder setAppendReorderData(boolean value)
       Include full precision data in the index. Use only in "
 "conjuction with compressed data on SSD. default is false. optional
      bool append_reorder_data = 9;
      Parameters:
      value - The appendReorderData to set.
      Returns:
      This builder for chaining.

    • clearAppendReorderData

      public Common.CreateDiskAnnParam.Builder clearAppendReorderData()
       Include full precision data in the index. Use only in "
 "conjuction with compressed data on SSD. default is false. optional
      bool append_reorder_data = 9;
      Returns:
      This builder for chaining.

    • getBuildPqBytes

      public int getBuildPqBytes()
       Number of PQ bytes to build the index; 0 for full precision build. default is 0. optional
      uint32 build_pq_bytes = 10;
      Specified by:
      getBuildPqBytes in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The buildPqBytes.

    • setBuildPqBytes

      public Common.CreateDiskAnnParam.Builder setBuildPqBytes(int value)
       Number of PQ bytes to build the index; 0 for full precision build. default is 0. optional
      uint32 build_pq_bytes = 10;
      Parameters:
      value - The buildPqBytes to set.
      Returns:
      This builder for chaining.

    • clearBuildPqBytes

      public Common.CreateDiskAnnParam.Builder clearBuildPqBytes()
       Number of PQ bytes to build the index; 0 for full precision build. default is 0. optional
      uint32 build_pq_bytes = 10;
      Returns:
      This builder for chaining.

    • getUseOpq

      public boolean getUseOpq()
       use OPQ instead of PQ. default is false. optional
      bool use_opq = 11;
      Specified by:
      getUseOpq in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The useOpq.

    • setUseOpq

      public Common.CreateDiskAnnParam.Builder setUseOpq(boolean value)
       use OPQ instead of PQ. default is false. optional
      bool use_opq = 11;
      Parameters:
      value - The useOpq to set.
      Returns:
      This builder for chaining.

    • clearUseOpq

      public Common.CreateDiskAnnParam.Builder clearUseOpq()
       use OPQ instead of PQ. default is false. optional
      bool use_opq = 11;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>

    • mergeUnknownFields

      public final Common.CreateDiskAnnParam.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.CreateDiskAnnParam.Builder>