@squidcloud/client/dist/typescript-client/src/scheduler-client.d.ts

A typescript implementation of the Squid client

import { SchedulerInfo } from './public-types';
/**
 * SchedulerClient provides methods to manage schedulers,
 * including listing, enabling, and disabling scheduled tasks.
 * @category Platform
 */
export declare class SchedulerClient {
    private readonly rpcManager;
    /**
     * Lists all configured schedulers.
     *
     * @returns A promise resolving to an array of scheduler metadata.
     */
    list(): Promise<SchedulerInfo[]>;
    /**
     * Enables one or more schedulers by their IDs.
     *
     * @param schedulerId A single scheduler ID or an array of scheduler IDs to enable.
     * @returns A promise that resolves once the update is complete.
     */
    enable(schedulerId: string | string[]): Promise<void>;
    /**
     * Disables one or more schedulers by their IDs.
     *
     * @param schedulerId A single scheduler ID or an array of scheduler IDs to disable.
     * @returns A promise that resolves once the update is complete.
     */
    disable(schedulerId: string | string[]): Promise<void>;
    private update;
    private createUpdateSchedulerOptions;
}