@datatr-ux/ovhcloud-types/dist/ipLoadbalancing/BackendProbe.d.ts

TypeScript types for OVHCloud projects

import { ProbeExpectMatchEnum } from './ProbeExpectMatchEnum';
import { ProbeMethodEnum } from './ProbeMethodEnum';
import { ProbeTypeEnum } from './ProbeTypeEnum';
/** Probe used to determine if a backend is alive and can handle requests */
export interface BackendProbe {
    /** Force probe to run over a SSL layer. Defaults to false */
    forceSsl?: boolean;
    /** Seconds between each probe check. Must be > 30sec. Defaults to 30 */
    interval?: number;
    /** Matcher to use to valide "expect". "default" uses HAProxy's default behavior for this type of check. "status" is only supported for HTTP probes */
    match?: ProbeExpectMatchEnum;
    /** HTTP method to use with "http" probe. Consider using HEAD to save bandwidth when possible. Defaults to "GET" */
    method?: ProbeMethodEnum;
    /** Invert the matching operator effect */
    negate?: boolean;
    /** Server response expected when UP. Empty for "default", comma delimited list of statuses for "status", string for "contains", regex for "matches" */
    pattern?: string;
    /** Port used to probe your backend. Equal to farm port if null. Ignored for oco probe type */
    port?: number;
    /** Probe type. "tcp" if null */
    type?: ProbeTypeEnum;
    /** URL to use for HTTP probes of the form [www.example.com]/path/to/check. Protocol will be ignored. Defaults to "/" */
    url?: string;
}
//# sourceMappingURL=BackendProbe.d.ts.map