Fix docs

docs/Drivers/Java/Reference/View/ArangoSearch.md

@@ -19,21 +19,31 @@ Creates a ArangoSearch view with the given _options_, then returns view informat
 
 - **options**: `ArangoSearchCreateOptions`
 
- - **locale**: `String`
-
- The default locale used for queries on analyzed string values (default: C).
-
- - **commitIntervalMsec**: `Long`
+ - **consolidationIntervalMsec**: `Long`
 
  Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added benefits.
 
  - **cleanupIntervalStep**: `Long`
 
  Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits.
 
- - **threshold**: `ConsolidateThreshold[]`
+ - **consolidationPolicy**:
+
+ - **type**: `ConsolidateType`
+
+ The type of the consolidation policy.
+
+ - **threshold**: `Double`
+
+ Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85)
+
+ - **segmentThreshold**: `Long`
+
+ Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments
 
- A list of consolidate thresholds
+ - **link**: `CollectionLink[]`
+
+ A list of linked collections
 
 **Examples**
 
@@ -58,21 +68,31 @@ Alternative for [ArangoDatabase.createArangoSearch](#arangodatabasecreatearangos
 
 - **options**: `ArangoSearchCreateOptions`
 
- - **locale**: `String`
-
- The default locale used for queries on analyzed string values (default: C).
-
- - **commitIntervalMsec**: `Long`
+ - **consolidationIntervalMsec**: `Long`
 
  Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added benefits.
 
  - **cleanupIntervalStep**: `Long`
 
  Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits.
 
- - **threshold**: `ConsolidateThreshold[]`
+ - **consolidationPolicy**:
+
+ - **type**: `ConsolidateType`
+
+ The type of the consolidation policy.
+
+ - **threshold**: `Double`
+
+ Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85)
+
+ - **segmentThreshold**: `Long`
 
- A list of consolidate thresholds
+ Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments
+
+ - **link**: `CollectionLink[]`
+
+ A list of linked collections
 
 **Examples**
 
@@ -115,25 +135,31 @@ Partially changes properties of the view.
 
 - **options**: `ArangoSearchPropertiesOptions`
 
- - **locale**: `String`
-
- The default locale used for queries on analyzed string values (default: C).
-
- - **commitIntervalMsec**: `Long`
+ - **consolidationIntervalMsec**: `Long`
 
  Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added benefits.
 
  - **cleanupIntervalStep**: `Long`
 
  Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits.
 
- - **threshold**: `ConsolidateThreshold[]`
+ - **consolidationPolicy**:
+
+ - **type**: `ConsolidateType`
+
+ The type of the consolidation policy.
+
+ - **threshold**: `Double`
+
+ Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85)
 
- A list of consolidate thresholds
+ - **segmentThreshold**: `Long`
 
- - **link**: `CollectionLink[]`
+  Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments
 
- A list of linked collections
+ - **link**: `CollectionLink[]`
+
+ A list of linked collections
 
 **Examples**
 
@@ -157,25 +183,31 @@ Changes properties of the view.
 
 - **options**: `ArangoSearchPropertiesOptions`
 
- - **locale**: `String`
-
- The default locale used for queries on analyzed string values (default: C).
-
- - **commitIntervalMsec**: `Long`
+ - **consolidationIntervalMsec**: `Long`
 
  Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added benefits.
 
  - **cleanupIntervalStep**: `Long`
 
  Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits.
 
- - **threshold**: `ConsolidateThreshold[]`
+ - **consolidationPolicy**:
+
+ - **type**: `ConsolidateType`
+
+ The type of the consolidation policy.
+
+ - **threshold**: `Double`
+
+ Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85)
+
+ - **segmentThreshold**: `Long`
 
- A list of consolidate thresholds
+  Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments
 
- - **link**: `CollectionLink[]`
+  - **link**: `CollectionLink[]`
 
- A list of linked collections
+  A list of linked collections
 
 **Examples**
 

src/main/java/com/arangodb/entity/arangosearch/ConsolidationPolicy.java

@@ -39,11 +39,23 @@ public static ConsolidationPolicy of(final ConsolidateType type) {
 return new ConsolidationPolicy(type);
 }
 
+/**
+ * @param threshold
+ * Select a given segment for "consolidation" if and only if the formula based on type (as defined above)
+ * evaluates to true, valid value range [0.0, 1.0] (default: 0.85)
+ * @return policy
+ */
 public ConsolidationPolicy threshold(final Double threshold) {
 this.threshold = threshold;
 return this;
 }
 
+/**
+ * @param segmentThreshold
+ * Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} <
+ * number_of_segments
+ * @return policy
+ */
 public ConsolidationPolicy segmentThreshold(final Long segmentThreshold) {
 this.segmentThreshold = segmentThreshold;
 return this;