| Class | Description |
|---|---|
| AbortIndexingAndImport |
Aborts index build, index and global dictionary import processes as soon as possible.
|
| AlphanumFieldConfig |
This field stores alphanumeric values (i.e., 'text', 'title').
|
| AnalysisPolicy |
Policy specifying how documents are dispatched to analysis threads.
|
| AnalysisStatus |
No documentation for this element.
|
| Apollo11EncoderConfig |
Stores each integer in Apollo11 encoding
|
| AreDocumentsSearchable |
Tests whether documents prior to a given serial number are searchable,
that is, available on the index slices.
A Serial value is retrieved from PAPI set_checkpoint calls. |
| ArityBasedFullCompactPolicy |
A FullCompactPolicy that compacts all slots into one whenever the "tail" of slots with smaller arities
exceeds together a certain arity.
The idea is that the arity-based policy guarantees occasional full-compaction, but the time interval between full-compaction increases exponentially. This add-on policy caps the increase at a certain arity, and schedules full-compacts at regular intervals afterwards. This policy is appropriate when auto-compacts are managed per generation-arity. In this case, a full optimization can occasionally be triggered to purge the deletes. If not, the deletes occurring in later slots would never be deleted, incurring performance costs at query-time and extra disk space consumption. |
| AttachSliceReplica |
Attaches a replica to its builder.
|
| AttributeGroupAccess |
Configuration specifying how to access the attribute group at runtime.
|
| AttributeGroupStore |
Configuration of an attribute group.
|
| AttributeReplicationConfig |
Attribute's replication configuration
|
| AutoCompactPolicy |
Base-class configuring how CloudView compacts index slots
|
| AutomaticAnalysisPolicy |
Depending on the number of threads specified, CloudView automatically chooses the most efficient analysis policy.
Changes made in Analyze require a restart of CloudView, or at least of the indexing server process, to be taken into account. |
| BinaryFieldConfig |
No documentation for this element.
|
| BuildGroupSpecific |
Commands related to a specific build group
|
| BuildGroupStatus |
Gets the status of a build group.
|
| CacheConfig |
PageCache configuration.
|
| CategoryFieldConfig |
Stores hierarchy content.
|
| ClearBuildGroup |
Clears a whole build group, deletes all data.
|
| ClearPrecomputedThumbnails |
Clears the precomputed thumbnails storage.
|
| ClearSliceReplica |
Removes the content of an index slice replica.
|
| CommitPolicy |
Base-class specifying the commit policy
|
| CommitTriggerCondition |
Specifies a condition to trigger a commit of the build group (to make the latest push operations available to the search).
|
| CompactDIH |
Perform a full compaction of the DIH.
|
| CompactDocumentCache |
Perform a full compaction of the document cache.
|
| CompactIndex |
Performs a compact on the index.
|
| CompactIndexAttributes |
Performs a compact on index attributes.
|
| CompactIndexField |
Performs a compact on an index field.
|
| CompactingStatus |
No documentation for this element.
|
| CompactPolicies |
No documentation for this element.
|
| CSVFileColumn |
No documentation for this element.
|
| DateFieldConfig |
No documentation for this element.
|
| DetachSliceReplica |
Detaches a replica from its builder.
|
| DisableAnalysis |
Disables the analysis build component, the CPU intensive step where documents are transformed to index slots.
|
| DisableImport |
Disables import: no documents will be added, deleted or updated in the index until the import is enabled again.
|
| DisablePushAPI |
Commands related to a specific build group
|
| DocumentCacheRepushStatus |
No documentation for this element.
|
| DocumentInfos |
No documentation for this element.
|
| DocumentInfosList |
List of document information in a build group.
|
| DoubleFieldConfig |
Configuration of a double precision floating point number field.
|
| EnableAnalysis |
Commands related to a specific build group
|
| EnableImport |
Commands related to a specific build group
|
| EnablePushAPI |
Enables the PushAPI, allowing documents to be pushed in the indexing chain.
|
| FastNoPosEncoderConfig |
An encoder that only stores docids, not ranks nor positions.
|
| FieldConfig |
No documentation for this element.
|
| FieldConfig.FromDataModel | |
| FieldReplicationConfig |
Index field replication configuration
|
| FieldRuntimeConfig |
Configuration specifying the index field at runtime.
|
| FixedThreadsAnalysisPolicy |
Instantiates a fixed number of analysis threads.
Dispatches documents according to their DIDs (Document IDs) and slice. |
| ForceDocumentCacheCommit | Deprecated |
| FreezeBuildGroup |
Freezes and unfreezes operations //
Freezes the product so that it can be safely backed up.
While the product is frozen, indexes can still be queried. |
| FullCompactIndex |
Performs a full compact on the whole index.
|
| FullCompactIndexAttributes |
Performs a full compact operation on all index attributes.
|
| FullCompactIndexField |
Performs a full compact on an index field.
|
| FullCompactPolicy |
Configures how CloudView full compacts index slots.
|
| GeoFieldConfig |
This type of field is used to store 2D geometries using either planar X,Y coordinates (Meter).
|
| GetBuildGroupStatus |
Commands related to a specific build group
|
| GetIndexedCheckpointsList |
No documentation for this element.
|
| GetIndexingConfigList |
Retrieves the list of all indexing configurations.
|
| GetIndexingConfigListByVersion |
Interface for every action specific to a given applied configuration version
|
| GetIndexRuntimeConfigList |
Retrieves the list of all index runtime configurations.
|
| GetIndexRuntimeConfigListByVersion |
Interface for every action specific to a given applied configuration version
|
| GetIndexSchemaList | |
| GetIndexSchemaListByVersion |
Interface for every action specific to a given applied configuration version
|
| GetProbeValuesForBuildGroup |
Gets the numerical probes for a given build group.
|
| GetReplicationStatus |
Gets the replication status of a build group.
|
| HierarchyFieldConfig |
Stores hierarchy content.
|
| ImportPolicy |
Policy specifying how analysis buffers are imported
|
| ImportStatus |
Status of the tasks processed by the build group.
This class contains counters. |
| InactivityCommitTriggerCondition |
Inactivity-based condition.
|
| IndexBuilderStatus |
No documentation for this element.
|
| IndexedCheckpoints |
No documentation for this element.
|
| IndexedCheckpoints.Checkpoints | |
| IndexedCheckpointsList |
A list of indexed checkpoints for a given search target
|
| IndexGetQueryCacheStatus |
Commands related to a specific index slice instance
|
| IndexingConfig |
No documentation for this element.
|
| IndexingConfigList |
Lists all indexing config list.
|
| IndexingStatus |
No documentation for this element.
|
| IndexManagementPolicy |
Base-class configuring index (service + build) runtime
|
| IndexQueryCacheStatus |
No documentation for this element.
|
| IndexRuntimeConfig |
Index runtime configuration for an instance of an index slice.
Use key values arguments to provide custom configuration keys. |
| IndexRuntimeConfigList |
Lists all index runtime config list.
|
| IndexSchema |
Configuration for an index schema.
|
| IndexSchemaList |
No documentation for this element.
|
| IndexSliceBuilderStatus |
No documentation for this element.
|
| IndexSliceInstanceSpecific |
Commands related to a specific index slice instance
|
| IndexSliceInstanceStatus |
No documentation for this element.
|
| IndexSliceSpecific |
Commands related to a specific index slice
|
| IndexSlicesSpecific |
Commands related to a specific set of index slices
|
| LegacySignedFieldConfig |
No documentation for this element.
|
| LegacyUnsignedFieldConfig |
No documentation for this element.
|
| ListDocumentInfos |
Lists the urls and stamps of the documents in a build group.
Warning: This method is heavy. |
| ListsEncoderConfig |
No documentation for this element.
|
| LowLatencyCompactPolicy |
Compacts when the size of all small slots is above the average large slot size,
or when the number of slots is above nbLargeSlots + maxNbSmallSlots. |
| LruElement |
No documentation for this element.
|
| MaxSizeFullCompactPolicy |
A FullCompactPolicy that compacts all slots into one whenever the "tail" of small slots
exceeds a certain ratio of the large first slot.
This policy is appropriate when auto-compacts are restricted to slots under a certain size for performance reasons. In this case, a full optimization can occasionally be triggered to purge the deletes. If not, the deletes occurring in later slots would never be deleted, incurring performance costs at query-time and extra disk space consumption. |
| MergedImportPolicy |
All analysis buffers are merged into a single one to be imported in an unique generation.
|
| NoCompactPolicy |
Compact policy that does not perform any compact.
|
| NoOpEncoderConfig |
Trivial encoder.
|
| NotifyNewImport |
Notify of a new import
|
| NumberOfSlotsBasedCompactPolicy |
Compaction policy based on a fixed number of slots for a given number of generations.
|
| NumberOfTasksBasedCommitTriggerCondition |
Triggers a commit after the specified No.
|
| NumericalFieldConfig |
No documentation for this element.
|
| ObjectFactory | |
| PageCacheStats |
No documentation for this element.
|
| ParallelImportPolicy |
For each analysis buffers one generation is created.
Analysis buffers are imported in parallel. |
| PeriodicCommitTriggerCondition |
Commits every N seconds after the first push order done after the last commit.
|
| PerSliceAnalysisPolicy |
Instantiates an analysis thread for each slice.
Dispatches documents according to their slice. Consumes less RAM than the 'FixedThreadsAnalysisPolicy'. |
| PerSliceInfo |
Returns per-slice information.
|
| PointFieldConfig |
This type of field is used to store geographical points using either GPS coordinates (WGS84) or planar X,Y coordinates (Meter).
|
| PushServerStatus |
The status of the pushserver.
|
| QueryAutocacheConfig |
Query #autocache configuration.
|
| RAMUsageCommitTriggerCondition |
Triggers a commit when RAM usage reaches the limit.
|
| ReferenceFieldConfig |
Stores alphanumerical content with an internal ordinal mapping, which makes it suitable for efficient facetting.
|
| RemoveDocumentCacheEntries |
* Erased documents from cache.
|
| ReplicationConfig |
Slice replication configuration
|
| ReplicationReplicaStatus |
No documentation for this element.
|
| ReplicationSliceStatus |
No documentation for this element.
|
| ReplicationStatus |
No documentation for this element.
|
| RepushFromDocumentCache |
Repushes documents from the document cache to the PAPI.
This is an asynchronous operation. |
| RepushSingleDocumentFromDocumentCache |
Repushes a document from the document cache to the PAPI.
This is an asynchronous operation. |
| RiceEncoderConfig |
No documentation for this element.
|
| RunGC |
Perform a garbage collection of the index unit.
|
| SameThreadAnalysisPolicy |
Instantiates an analysis thread for each incoming PAPI thread.
Each PAPI thread analyzes its tasks synchronously. |
| SetIndexingConfigList |
Sets the list of all index runtime configurations.
|
| SetIndexRuntimeConfigList |
Sets the list of all index runtime configurations.
|
| SetIndexSchemaList | |
| SignedFieldConfig |
No documentation for this element.
|
| SizeBasedCommitTriggerCondition |
Triggers a commit when the Max size (MB) is reached.
|
| SlotsLogSizeBasedCompactPolicy |
A CompactPolicy that tries to compact slots into levels of exponentially increasing size,
where each level has fewer slots than the value of the compact factor.
Whenever extra slots (beyond the compact factor upper bound) are encountered, all slots within the level are compacted. |
| SlotsSizeBasedCompactPolicy |
Compaction policy based on size that produces slots with similar size.
When N consecutive slots have a size below targetSizeForCompactionMB, it performs a compaction if: N is at least minArity AND The N+1 slot makes the size above targetSizeForCompactionMB OR The size is above minSizeForCompactionMB |
| SortableFieldConfig |
No documentation for this element.
|
| StandardCommitPolicy |
Default commit policy
|
| StandardFieldConfig |
No documentation for this element.
|
| StandardIndexManagementPolicy |
Default index (service + build) runtime configuration
|
| StandardUploadPolicy |
Default upload policy
|
| SyncTaskQueue |
Message sent to the PAPI to indicate that a sync must be performed.
|
| TakeBuildGroupDataOwnership |
/!\ expert only,
Deletes all data of the target BG (data will be lost), and steal data of the buildGroup to recover at the benefitis of the target one. |
| TasksStatus |
No documentation for this element.
|
| TasksStatus.Bytes | |
| TasksStatus.Deletions | |
| TasksStatus.ExistingDocumentAdds | |
| TasksStatus.NewDocumentAdds | |
| TasksStatus.PartialUpdates | |
| TasksStatus.Tasks | |
| TextFieldConfig |
Stores alphanumerical content with an internal ordinal mapping, which makes it suitable for efficient facetting.
|
| ThumbnailsStatus |
No documentation for this element.
|
| TimeFieldConfig |
No documentation for this element.
|
| ToggleBuildComponent |
Commands related to a specific build group
|
| TriggerIndexingJob |
Immediately triggers a job for index build with the documents
currently in the queue, bypassing the trigger conditions defined in the indexbuilder configuration. |
| UidFieldConfig |
This field stores a unique value in order to facilitate search.
|
| UnfreezeBuildGroup |
Unfreezes the product state.
|
| UnsignedFieldConfig |
No documentation for this element.
|
| UploadPolicy |
Base-class specifying the upload policy
|
| ValueFieldConfig |
Stores alphanumerical content with an internal ordinal mapping, which makes it suitable for efficient facetting.
|
| VarIntEncoderConfig |
Stores each integer in varint encoding
|
| WaitNewImport |
Waits for next new import.
|
| WarmupConfig |
Index warmup configuration
|
| WriteAttributeSlotConfig |
Write attribute slot configuration
|
| WriteSlotConfig |
Write slot configuration
|
Copyright © 2021 Dassault Systèmes, All Rights Reserved.