Package io.qdrant.client.grpc

Class Collections.OptimizersConfigDiff.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Collections.OptimizersConfigDiff.Builder>
io.qdrant.client.grpc.Collections.OptimizersConfigDiff.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Collections.OptimizersConfigDiffOrBuilder, Cloneable
Enclosing class:
Collections.OptimizersConfigDiff
public static final class Collections.OptimizersConfigDiff.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Collections.OptimizersConfigDiff.Builder> implements Collections.OptimizersConfigDiffOrBuilder
Protobuf type qdrant.OptimizersConfigDiff

  • 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<Collections.OptimizersConfigDiff.Builder>

    • clear

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • getDefaultInstanceForType

      public Collections.OptimizersConfigDiff getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • setField

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • clearField

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • clearOneof

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • setRepeatedField

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • addRepeatedField

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • mergeFrom

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • mergeFrom

      public Collections.OptimizersConfigDiff.Builder mergeFrom(Collections.OptimizersConfigDiff other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Collections.OptimizersConfigDiff.Builder>

    • mergeFrom

      public Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>
      Throws:
      IOException

    • hasDeletedThreshold

      public boolean hasDeletedThreshold()
      
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
      optional double deleted_threshold = 1;
      Specified by:
      hasDeletedThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the deletedThreshold field is set.

    • getDeletedThreshold

      public double getDeletedThreshold()
      
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
      optional double deleted_threshold = 1;
      Specified by:
      getDeletedThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The deletedThreshold.

    • setDeletedThreshold

      public Collections.OptimizersConfigDiff.Builder setDeletedThreshold(double value)
      
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
      optional double deleted_threshold = 1;
      Parameters:
      value - The deletedThreshold to set.
      Returns:
      This builder for chaining.

    • clearDeletedThreshold

      public Collections.OptimizersConfigDiff.Builder clearDeletedThreshold()
      
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
      optional double deleted_threshold = 1;
      Returns:
      This builder for chaining.

    • hasVacuumMinVectorNumber

      public boolean hasVacuumMinVectorNumber()
      
The minimal number of vectors in a segment, required to perform segment optimization
      optional uint64 vacuum_min_vector_number = 2;
      Specified by:
      hasVacuumMinVectorNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the vacuumMinVectorNumber field is set.

    • getVacuumMinVectorNumber

      public long getVacuumMinVectorNumber()
      
The minimal number of vectors in a segment, required to perform segment optimization
      optional uint64 vacuum_min_vector_number = 2;
      Specified by:
      getVacuumMinVectorNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The vacuumMinVectorNumber.

    • setVacuumMinVectorNumber

      public Collections.OptimizersConfigDiff.Builder setVacuumMinVectorNumber(long value)
      
The minimal number of vectors in a segment, required to perform segment optimization
      optional uint64 vacuum_min_vector_number = 2;
      Parameters:
      value - The vacuumMinVectorNumber to set.
      Returns:
      This builder for chaining.

    • clearVacuumMinVectorNumber

      public Collections.OptimizersConfigDiff.Builder clearVacuumMinVectorNumber()
      
The minimal number of vectors in a segment, required to perform segment optimization
      optional uint64 vacuum_min_vector_number = 2;
      Returns:
      This builder for chaining.

    • hasDefaultSegmentNumber

      public boolean hasDefaultSegmentNumber()
      
Target amount of segments the optimizer will try to keep.
Real amount of segments may vary depending on multiple parameters:

- Amount of stored points.
- Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads,
so that each segment would be handled evenly by one of the threads.
      optional uint64 default_segment_number = 3;
      Specified by:
      hasDefaultSegmentNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the defaultSegmentNumber field is set.

    • getDefaultSegmentNumber

      public long getDefaultSegmentNumber()
      
Target amount of segments the optimizer will try to keep.
Real amount of segments may vary depending on multiple parameters:

- Amount of stored points.
- Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads,
so that each segment would be handled evenly by one of the threads.
      optional uint64 default_segment_number = 3;
      Specified by:
      getDefaultSegmentNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The defaultSegmentNumber.

    • setDefaultSegmentNumber

      public Collections.OptimizersConfigDiff.Builder setDefaultSegmentNumber(long value)
      
Target amount of segments the optimizer will try to keep.
Real amount of segments may vary depending on multiple parameters:

- Amount of stored points.
- Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads,
so that each segment would be handled evenly by one of the threads.
      optional uint64 default_segment_number = 3;
      Parameters:
      value - The defaultSegmentNumber to set.
      Returns:
      This builder for chaining.

    • clearDefaultSegmentNumber

      public Collections.OptimizersConfigDiff.Builder clearDefaultSegmentNumber()
      
Target amount of segments the optimizer will try to keep.
Real amount of segments may vary depending on multiple parameters:

- Amount of stored points.
- Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads,
so that each segment would be handled evenly by one of the threads.
      optional uint64 default_segment_number = 3;
      Returns:
      This builder for chaining.

    • hasMaxSegmentSize

      public boolean hasMaxSegmentSize()
      
Do not create segments larger this size (in kilobytes).
Large segments might require disproportionately long indexation times,
therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower.
If search speed is more important - make this parameter higher.
Note: 1Kb = 1 vector of size 256
If not set, will be automatically selected considering the number of available CPUs.
      optional uint64 max_segment_size = 4;
      Specified by:
      hasMaxSegmentSize in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the maxSegmentSize field is set.

    • getMaxSegmentSize

      public long getMaxSegmentSize()
      
Do not create segments larger this size (in kilobytes).
Large segments might require disproportionately long indexation times,
therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower.
If search speed is more important - make this parameter higher.
Note: 1Kb = 1 vector of size 256
If not set, will be automatically selected considering the number of available CPUs.
      optional uint64 max_segment_size = 4;
      Specified by:
      getMaxSegmentSize in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The maxSegmentSize.

    • setMaxSegmentSize

      public Collections.OptimizersConfigDiff.Builder setMaxSegmentSize(long value)
      
Do not create segments larger this size (in kilobytes).
Large segments might require disproportionately long indexation times,
therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower.
If search speed is more important - make this parameter higher.
Note: 1Kb = 1 vector of size 256
If not set, will be automatically selected considering the number of available CPUs.
      optional uint64 max_segment_size = 4;
      Parameters:
      value - The maxSegmentSize to set.
      Returns:
      This builder for chaining.

    • clearMaxSegmentSize

      public Collections.OptimizersConfigDiff.Builder clearMaxSegmentSize()
      
Do not create segments larger this size (in kilobytes).
Large segments might require disproportionately long indexation times,
therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower.
If search speed is more important - make this parameter higher.
Note: 1Kb = 1 vector of size 256
If not set, will be automatically selected considering the number of available CPUs.
      optional uint64 max_segment_size = 4;
      Returns:
      This builder for chaining.

    • hasMemmapThreshold

      public boolean hasMemmapThreshold()
      
Maximum size (in kilobytes) of vectors to store in-memory per segment.
Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to `0`.

Note: 1Kb = 1 vector of size 256
      optional uint64 memmap_threshold = 5;
      Specified by:
      hasMemmapThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the memmapThreshold field is set.

    • getMemmapThreshold

      public long getMemmapThreshold()
      
Maximum size (in kilobytes) of vectors to store in-memory per segment.
Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to `0`.

Note: 1Kb = 1 vector of size 256
      optional uint64 memmap_threshold = 5;
      Specified by:
      getMemmapThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The memmapThreshold.

    • setMemmapThreshold

      public Collections.OptimizersConfigDiff.Builder setMemmapThreshold(long value)
      
Maximum size (in kilobytes) of vectors to store in-memory per segment.
Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to `0`.

Note: 1Kb = 1 vector of size 256
      optional uint64 memmap_threshold = 5;
      Parameters:
      value - The memmapThreshold to set.
      Returns:
      This builder for chaining.

    • clearMemmapThreshold

      public Collections.OptimizersConfigDiff.Builder clearMemmapThreshold()
      
Maximum size (in kilobytes) of vectors to store in-memory per segment.
Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to `0`.

Note: 1Kb = 1 vector of size 256
      optional uint64 memmap_threshold = 5;
      Returns:
      This builder for chaining.

    • hasIndexingThreshold

      public boolean hasIndexingThreshold()
      
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.
      optional uint64 indexing_threshold = 6;
      Specified by:
      hasIndexingThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the indexingThreshold field is set.

    • getIndexingThreshold

      public long getIndexingThreshold()
      
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.
      optional uint64 indexing_threshold = 6;
      Specified by:
      getIndexingThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The indexingThreshold.

    • setIndexingThreshold

      public Collections.OptimizersConfigDiff.Builder setIndexingThreshold(long value)
      
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.
      optional uint64 indexing_threshold = 6;
      Parameters:
      value - The indexingThreshold to set.
      Returns:
      This builder for chaining.

    • clearIndexingThreshold

      public Collections.OptimizersConfigDiff.Builder clearIndexingThreshold()
      
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.
      optional uint64 indexing_threshold = 6;
      Returns:
      This builder for chaining.

    • hasFlushIntervalSec

      public boolean hasFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Specified by:
      hasFlushIntervalSec in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the flushIntervalSec field is set.

    • getFlushIntervalSec

      public long getFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Specified by:
      getFlushIntervalSec in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The flushIntervalSec.

    • setFlushIntervalSec

      public Collections.OptimizersConfigDiff.Builder setFlushIntervalSec(long value)
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Parameters:
      value - The flushIntervalSec to set.
      Returns:
      This builder for chaining.

    • clearFlushIntervalSec

      public Collections.OptimizersConfigDiff.Builder clearFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Returns:
      This builder for chaining.

    • hasMaxOptimizationThreads

      public boolean hasMaxOptimizationThreads()
      
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
      optional uint64 max_optimization_threads = 8;
      Specified by:
      hasMaxOptimizationThreads in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the maxOptimizationThreads field is set.

    • getMaxOptimizationThreads

      public long getMaxOptimizationThreads()
      
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
      optional uint64 max_optimization_threads = 8;
      Specified by:
      getMaxOptimizationThreads in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The maxOptimizationThreads.

    • setMaxOptimizationThreads

      public Collections.OptimizersConfigDiff.Builder setMaxOptimizationThreads(long value)
      
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
      optional uint64 max_optimization_threads = 8;
      Parameters:
      value - The maxOptimizationThreads to set.
      Returns:
      This builder for chaining.

    • clearMaxOptimizationThreads

      public Collections.OptimizersConfigDiff.Builder clearMaxOptimizationThreads()
      
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
      optional uint64 max_optimization_threads = 8;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>

    • mergeUnknownFields

      public final Collections.OptimizersConfigDiff.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<Collections.OptimizersConfigDiff.Builder>