/** * Typesense API * An open source search engine for building delightful search experiences. * * The version of the OpenAPI document: 30.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime.js'; import type { APIStatsResponse, SchemaChangeStatus, SuccessStatus, ToggleSlowRequestLogRequest } from '../models/index.js'; export interface TakeSnapshotRequest { snapshotPath: string; } export interface ToggleSlowRequestLogOperationRequest { toggleSlowRequestLogRequest?: ToggleSlowRequestLogRequest; } /** * */ export declare class OperationsApi extends runtime.BaseAPI { /** * Clear the cached responses of search requests that are sent with `use_cache` parameter in the LRU cache. * Clear the cached responses of search requests in the LRU cache. */ clearCacheRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Clear the cached responses of search requests that are sent with `use_cache` parameter in the LRU cache. * Clear the cached responses of search requests in the LRU cache. */ clearCache(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Typesense uses RocksDB to store your documents on the disk. If you do frequent writes or updates, you could benefit from running a compaction of the underlying RocksDB database. This could reduce the size of the database and decrease read latency. While the database will not block during this operation, we recommend running it during off-peak hours. * Compacting the on-disk database */ compactDbRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Typesense uses RocksDB to store your documents on the disk. If you do frequent writes or updates, you could benefit from running a compaction of the underlying RocksDB database. This could reduce the size of the database and decrease read latency. While the database will not block during this operation, we recommend running it during off-peak hours. * Compacting the on-disk database */ compactDb(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response. * Get the status of in-progress schema change operations */ getSchemaChangesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response. * Get the status of in-progress schema change operations */ getSchemaChanges(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the stats about API endpoints. * Get stats about API endpoints. */ retrieveAPIStatsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the stats about API endpoints. * Get stats about API endpoints. */ retrieveAPIStats(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve the metrics. * Get current RAM, CPU, Disk & Network usage metrics. */ retrieveMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the metrics. * Get current RAM, CPU, Disk & Network usage metrics. */ retrieveMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates a point-in-time snapshot of a Typesense node\'s state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed. * Creates a point-in-time snapshot of a Typesense node\'s state and data in the specified directory. */ takeSnapshotRaw(requestParameters: TakeSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a point-in-time snapshot of a Typesense node\'s state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed. * Creates a point-in-time snapshot of a Typesense node\'s state and data in the specified directory. */ takeSnapshot(requestParameters: TakeSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Enable logging of requests that take over a defined threshold of time. Default is `-1` which disables slow request logging. Slow requests are logged to the primary log file, with the prefix SLOW REQUEST. * Toggle Slow Request Log */ toggleSlowRequestLogRaw(requestParameters: ToggleSlowRequestLogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable logging of requests that take over a defined threshold of time. Default is `-1` which disables slow request logging. Slow requests are logged to the primary log file, with the prefix SLOW REQUEST. * Toggle Slow Request Log */ toggleSlowRequestLog(requestParameters?: ToggleSlowRequestLogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Triggers a follower node to initiate the raft voting process, which triggers leader re-election. The follower node that you run this operation against will become the new leader, once this command succeeds. * Triggers a follower node to initiate the raft voting process, which triggers leader re-election. */ voteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Triggers a follower node to initiate the raft voting process, which triggers leader re-election. The follower node that you run this operation against will become the new leader, once this command succeeds. * Triggers a follower node to initiate the raft voting process, which triggers leader re-election. */ vote(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }