import { Client } from '../client.js'; import { Models } from '../models.js'; import { Name } from '../enums/name.js'; import '../query.js'; import '../enums/database-type.js'; import '../enums/attribute-status.js'; import '../enums/column-status.js'; import '../enums/index-status.js'; import '../enums/deployment-status.js'; import '../enums/execution-trigger.js'; import '../enums/execution-status.js'; import '../enums/health-antivirus-status.js'; import '../enums/health-check-status.js'; import '../enums/message-status.js'; declare class Health { client: Client; constructor(client: Client); /** * Check the Appwrite HTTP server is up and responsive. * * @throws {AppwriteException} * @returns {Promise} */ get(): Promise; /** * Check the Appwrite Antivirus server is up and connection is successful. * * @throws {AppwriteException} * @returns {Promise} */ getAntivirus(): Promise; /** * Check the Appwrite in-memory cache servers are up and connection is successful. * * @throws {AppwriteException} * @returns {Promise} */ getCache(): Promise; /** * Get the SSL certificate for a domain * * @param {string} params.domain - string * @throws {AppwriteException} * @returns {Promise} */ getCertificate(params?: { domain?: string; }): Promise; /** * Get the SSL certificate for a domain * * @param {string} domain - string * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getCertificate(domain?: string): Promise; /** * Check the Appwrite database servers are up and connection is successful. * * @throws {AppwriteException} * @returns {Promise} */ getDB(): Promise; /** * Check the Appwrite pub-sub servers are up and connection is successful. * * @throws {AppwriteException} * @returns {Promise} */ getPubSub(): Promise; /** * Get the number of builds that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueBuilds(params?: { threshold?: number; }): Promise; /** * Get the number of builds that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueBuilds(threshold?: number): Promise; /** * Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueCertificates(params?: { threshold?: number; }): Promise; /** * Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueCertificates(threshold?: number): Promise; /** * Get the number of database changes that are waiting to be processed in the Appwrite internal queue server. * * @param {string} params.name - Queue name for which to check the queue size * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueDatabases(params?: { name?: string; threshold?: number; }): Promise; /** * Get the number of database changes that are waiting to be processed in the Appwrite internal queue server. * * @param {string} name - Queue name for which to check the queue size * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueDatabases(name?: string, threshold?: number): Promise; /** * Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueDeletes(params?: { threshold?: number; }): Promise; /** * Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueDeletes(threshold?: number): Promise; /** * Returns the amount of failed jobs in a given queue. * * * @param {Name} params.name - The name of the queue * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getFailedJobs(params: { name: Name; threshold?: number; }): Promise; /** * Returns the amount of failed jobs in a given queue. * * * @param {Name} name - The name of the queue * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getFailedJobs(name: Name, threshold?: number): Promise; /** * Get the number of function executions that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueFunctions(params?: { threshold?: number; }): Promise; /** * Get the number of function executions that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueFunctions(threshold?: number): Promise; /** * Get the number of logs that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueLogs(params?: { threshold?: number; }): Promise; /** * Get the number of logs that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueLogs(threshold?: number): Promise; /** * Get the number of mails that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueMails(params?: { threshold?: number; }): Promise; /** * Get the number of mails that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueMails(threshold?: number): Promise; /** * Get the number of messages that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueMessaging(params?: { threshold?: number; }): Promise; /** * Get the number of messages that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueMessaging(threshold?: number): Promise; /** * Get the number of migrations that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueMigrations(params?: { threshold?: number; }): Promise; /** * Get the number of migrations that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueMigrations(threshold?: number): Promise; /** * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueStatsResources(params?: { threshold?: number; }): Promise; /** * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueStatsResources(threshold?: number): Promise; /** * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueUsage(params?: { threshold?: number; }): Promise; /** * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueUsage(threshold?: number): Promise; /** * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server. * * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} */ getQueueWebhooks(params?: { threshold?: number; }): Promise; /** * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server. * * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. * @throws {AppwriteException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ getQueueWebhooks(threshold?: number): Promise; /** * Check the Appwrite storage device is up and connection is successful. * * @throws {AppwriteException} * @returns {Promise} */ getStorage(): Promise; /** * Check the Appwrite local storage device is up and connection is successful. * * @throws {AppwriteException} * @returns {Promise} */ getStorageLocal(): Promise; /** * Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP. * * @throws {AppwriteException} * @returns {Promise} */ getTime(): Promise; } export { Health };