@deephaven-enterprise/query-utils 1.20240723.62-alpha-fix-dependencies.1

package/dist/QueryScheduler.d.ts

@@ -0,0 +1,348 @@
+import { CalendarDateTime } from '@internationalized/date';
+/**
+ * QueryScheduler is the client side equivalent of the server side class IrisScheduler.
+ *
+ * The server stores scheduling data as an array of Strings.  This class converts that array
+ * into an object that can be manipulated by the UI.  It then converts back to an array for
+ * storage on the server.
+ */
+export declare class QueryScheduler {
+    type: string;
+    startTimeInternal: number;
+    stopTimeInternal: number;
+    timeZone: string;
+    schedulingDisabled: boolean;
+    overnightInternal: boolean;
+    repeatEnabled: boolean;
+    stopTimeDisabledInternal: boolean;
+    repeatInterval: number;
+    skipIfUnsuccessful: boolean;
+    restartErrorCount: number;
+    restartDelayMinutes: number;
+    restartWhenRunning: string;
+    businessDays: boolean;
+    dailyBusinessCalendar: string;
+    dailyDays: boolean[];
+    firstBusinessDay: boolean;
+    lastBusinessDay: boolean;
+    specificDays: boolean;
+    months: boolean[];
+    monthlyDays: boolean[];
+    monthlyBusinessCalendar: string;
+    dailyRestart: boolean;
+    runOnFailure: boolean;
+    restartOnCondition: boolean;
+    dependentOnQuerySerials: string[];
+    useMinStartTime: boolean;
+    runOnAny: boolean;
+    deadlineStartTime: number;
+    deadlineEndTime: number;
+    runEveryTime: boolean;
+    temporaryQueueName: string;
+    expirationTimeMillis: number;
+    temporaryDependentOnQuerySerials: string[];
+    startDateTime: CalendarDateTime | null;
+    stopDateTime: CalendarDateTime | null;
+    static defaultCalendar?: string;
+    /**
+     * Creates a Default Scheduler.
+     */
+    static createDefault: () => QueryScheduler;
+    static makeDefaultScheduling(restartQueryWhenRunningDefault: string, timeZone: string): [string, string];
+    static setDefaultCalendar(name: string): void;
+    static parseLocalTime: (string: string) => number;
+    static localTimeToString: (timeInSeconds: number) => string;
+    static MAX_LOCAL_TIME: number;
+    static INVALID_SERIAL: string;
+    static arrayToDelimitedString: <T>(token: string, array: T[]) => string;
+    static TYPES: Readonly<{
+        DAILY: "com.illumon.iris.controller.IrisQuerySchedulerDaily";
+        MONTHLY: "com.illumon.iris.controller.IrisQuerySchedulerMonthly";
+        CONTINUOUS: "com.illumon.iris.controller.IrisQuerySchedulerContinuous";
+        DEPENDENT: "com.illumon.iris.controller.IrisQuerySchedulerDependent";
+        TEMPORARY: "com.illumon.iris.controller.IrisQuerySchedulerTemporary";
+        RANGE: "com.illumon.iris.controller.IrisQuerySchedulerRange";
+    }>;
+    static TOKENS: Readonly<{
+        SCHEDULER_TYPE: "SchedulerType";
+        DELIMITER: "=";
+        START_TIME: "StartTime";
+        STOP_TIME: "StopTime";
+        OVERNIGHT: "Overnight";
+        TIME_ZONE: "TimeZone";
+        DISABLED: "SchedulingDisabled";
+        REPEAT_ENABLED: "RepeatEnabled";
+        REPEAT_INTERVAL: "RepeatInterval";
+        SKIP_IF_UNSUCCESSFUL: "SkipIfUnsuccessful";
+        STOP_TIME_DISABLED: "StopTimeDisabled";
+        RESTART_ERROR_COUNT: "RestartErrorCount";
+        RESTART_ERROR_DELAY: "RestartErrorDelay";
+        RESTART_WHEN_RUNNING: "RestartWhenRunning";
+        BUSINESS_DAYS: "BusinessDays";
+        CALENDAR: "Calendar";
+        DAYS: "Days";
+        FIRST_BUSINESS_DAY: "FirstBusinessDay";
+        LAST_BUSINESS_DAY: "LastBusinessDay";
+        SPECIFIC_DAYS: "SpecificDays";
+        MONTHS: "Months";
+        DAILY_RESTART: "DailyRestart";
+        RUN_ON_FAILURE: "RunOnFailure";
+        RESTART_ON_CONDITION: "RestartOnCondition";
+        DEPENDENT_QUERY_SERIAL: "DependentQuerySerial";
+        USE_MIN_START_TIME: "UseMinStartTime";
+        RUN_ON_ANY: "RunOnAny";
+        DEADLINE_START: "DeadlineStart";
+        DEADLINE_END: "DeadlineEnd";
+        RUN_EACH_TIME: "RunEachTime";
+        TEMPORARY_QUEUE_NAME: "TemporaryQueueName";
+        TEMPORARY_EXPIRATION_TIME_MILLIS: "TemporaryExpirationTimeMillis";
+        TEMPORARY_DEPENDENT_QUERY_SERIAL: "TemporaryDependentQuerySerial";
+        USE_START_DATE_TIME: "UseStartDateTime";
+        USE_STOP_DATE_TIME: "UseStopDateTime";
+        START_DATE: "StartDate";
+        STOP_DATE: "StopDate";
+        SERIAL_DELIMITER: ";";
+    }>;
+    static FIELDS: Readonly<{
+        readonly TYPE: "type";
+        readonly START_TIME: "startTime";
+        readonly STOP_TIME: "stopTime";
+        readonly TIME_ZONE: "timeZone";
+        readonly SCHEDULING_DISABLED: "schedulingDisabled";
+        readonly OVERNIGHT: "overnight";
+        readonly REPEAT_ENABLED: "repeatEnabled";
+        readonly STOP_TIME_DISABLED: "stopTimeDisabled";
+        readonly REPEAT_INTERVAL: "repeatInterval";
+        readonly SKIP_IF_UNSUCCESSFUL: "skipIfUnsuccessful";
+        readonly RESTART_ERROR_COUNT: "restartErrorCount";
+        readonly RESTART_DELAY_MINUTES: "restartDelayMinutes";
+        readonly RESTART_WHEN_RUNNING: "restartWhenRunning";
+        readonly BUSINESS_DAYS: "businessDays";
+        readonly DAILY_BUSINESS_CALENDAR: "dailyBusinessCalendar";
+        readonly DAILY_DAYS: "dailyDays";
+        readonly FIRST_BUSINESS_DAY: "firstBusinessDay";
+        readonly LAST_BUSINESS_DAY: "lastBusinessDay";
+        readonly SPECIFIC_DAYS: "specificDays";
+        readonly MONTHS: "months";
+        readonly MONTHLY_DAYS: "monthlyDays";
+        readonly MONTHLY_BUSINESS_CALENDAR: "monthlyBusinessCalendar";
+        readonly DAILY_RESTART: "dailyRestart";
+        readonly RUN_ON_FAILURE: "runOnFailure";
+        readonly RESTART_ON_CONDITION: "restartOnCondition";
+        readonly DEPENDENT_ON_QUERY_SERIALS: "dependentOnQuerySerials";
+        readonly USE_MIN_START_TIME: "useMinStartTime";
+        readonly RUN_ON_ANY: "runOnAny";
+        readonly DEADLINE_START_TIME: "deadlineStartTime";
+        readonly DEADLINE_END_TIME: "deadlineEndTime";
+        readonly RUN_EVERY_TIME: "runEveryTime";
+        readonly TEMPORARY_QUEUE_NAME: "temporaryQueueName";
+        readonly EXPIRATION_TIME_MILLIS: "expirationTimeMillis";
+        readonly TEMPORARY_DEPENDENT_ON_QUERY_SERIALS: "temporaryDependentOnQuerySerials";
+        readonly START_DATE_TIME: "startDateTime";
+        readonly STOP_DATE_TIME: "stopDateTime";
+    }>;
+    static DAYS_PER_WEEK: number;
+    static DAYS_PER_MONTH: number;
+    static MONTHS_PER_YEAR: number;
+    static MAX_ERROR_RESTART_COUNT: number;
+    static UNLIMITED_ERROR_RESTART_INDEX: number;
+    static DAYS: Readonly<{
+        SUN: {
+            text: string;
+            value: number;
+        };
+        MON: {
+            text: string;
+            value: number;
+        };
+        TUE: {
+            text: string;
+            value: number;
+        };
+        WED: {
+            text: string;
+            value: number;
+        };
+        THU: {
+            text: string;
+            value: number;
+        };
+        FRI: {
+            text: string;
+            value: number;
+        };
+        SAT: {
+            text: string;
+            value: number;
+        };
+    }>;
+    static MONTHS: Readonly<{
+        JAN: {
+            text: string;
+            value: number;
+        };
+        FEB: {
+            text: string;
+            value: number;
+        };
+        MAR: {
+            text: string;
+            value: number;
+        };
+        APR: {
+            text: string;
+            value: number;
+        };
+        MAY: {
+            text: string;
+            value: number;
+        };
+        JUN: {
+            text: string;
+            value: number;
+        };
+        JUL: {
+            text: string;
+            value: number;
+        };
+        AUG: {
+            text: string;
+            value: number;
+        };
+        SEP: {
+            text: string;
+            value: number;
+        };
+        OCT: {
+            text: string;
+            value: number;
+        };
+        NOV: {
+            text: string;
+            value: number;
+        };
+        DEC: {
+            text: string;
+            value: number;
+        };
+    }>;
+    static RESTART_WHEN_RUNNING_OPTION: Readonly<{
+        YES: "Yes";
+        NO: "No";
+    }>;
+    static validateSplitLength(s: unknown, splitString: string[], length: number): void;
+    /**
+     * Creats a new QueryScheduler object.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    constructor(stringArray?: readonly string[]);
+    /**
+     * Automatically turns the overnight flag on / off based on start and stop time.
+     */
+    checkForOvernight(): void;
+    get startTime(): number;
+    set startTime(value: number);
+    get stopTime(): number;
+    set stopTime(value: number);
+    get overnight(): boolean;
+    set overnight(value: boolean);
+    get stopTimeDisabled(): boolean;
+    set stopTimeDisabled(value: boolean);
+    /**
+     * Creates a deep copy of this scheduler.
+     *
+     * @returns a copy of this scheduler
+     */
+    deepCopy(): QueryScheduler;
+    /**
+     * Ensures that the scheduler has meaningful defaults for all fields.  This allows
+     * the UI to quickly switch between scheduler types.  Note that these defaults do
+     * not create valid schedulers for all types.
+     */
+    initDefaults(): void;
+    /**
+     * Parses an array of strings into a QueryScheduler object.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseFromStringArray(stringArray: readonly string[]): void;
+    /**
+     * Does the base parsing that is common to all scheduler types.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     * @returns an array of strings fo type specific parsers
+     */
+    parseBaseScheduler(stringArray: readonly string[]): string[];
+    /**
+     * Parses the Daily scheduler type.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseDailyScheduler(stringArray: string[]): void;
+    /**
+     * Parses the Monthly scheduler type.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseMonthlyScheduler(stringArray: string[]): void;
+    /**
+     * Parses the Continuous scheduler type.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseContinuousScheduler(stringArray: string[]): void;
+    /**
+     * Parses the Dependent scheduler type.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseDependentScheduler(stringArray: string[]): void;
+    /**
+     * Parses the Temporary scheduler type.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseTemporaryScheduler(stringArray: string[]): void;
+    /**
+     * Parses the Range scheduler type.
+     *
+     * @param stringArray an array of strings representing a scheduler
+     */
+    parseRangeScheduler(stringArray: string[]): void;
+    /**
+     * Generates an array of strings that describes the scheduler.
+     *
+     * @returns an array of strings describing the scheduler
+     */
+    toStringArray(): string[];
+    /**
+     * Generates an array of strings for the Base scheduler.
+     */
+    toStringArrayBase(arrayEntries: string[]): void;
+    /**
+     * Generates an array of strings for a Daily scheduler.
+     */
+    toStringArrayDaily(arrayEntries: string[]): void;
+    /**
+     * Generates an array of strings for a Monthly scheduler.
+     */
+    toStringArrayMonthly(arrayEntries: string[]): void;
+    /**
+     * Generates an array of strings for a Continuous scheduler.
+     */
+    toStringArrayContinuous(arrayEntries: string[]): void;
+    /**
+     * Generates an array of strings for a Dependent scheduler.
+     */
+    toStringArrayDependent(arrayEntries: string[]): void;
+    /**
+     * Generates an array of strings for a Temporary scheduler.
+     */
+    toStringArrayTemporary(arrayEntries: string[]): void;
+    /**
+     * Generates an array of strings for a Range scheduler.
+     */
+    toStringArrayRange(arrayEntries: string[]): void;
+}
+export default QueryScheduler;