@datadog/datadog-api-client/dist/packages/datadog-api-client-v1/models/DowntimeRecurrence.d.ts

OpenAPI client for Datadog APIs

/**
 * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
 * This product includes software developed at Datadog (https://www.datadoghq.com/).
 * Copyright 2020-Present Datadog, Inc.
 */
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
 * An object defining the recurrence of the downtime.
 */
export declare class DowntimeRecurrence {
    /**
     * How often to repeat as an integer.
     * For example, to repeat every 3 days, select a type of `days` and a period of `3`.
     */
    "period"?: number;
    /**
     * The `RRULE` standard for defining recurring events (**requires to set "type" to rrule**)
     * For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.
     * Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.
     *
     * **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).
     * More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api)
     */
    "rrule"?: string;
    /**
     * The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`.
     */
    "type"?: string;
    /**
     * The date at which the recurrence should end as a POSIX timestamp.
     * `until_occurences` and `until_date` are mutually exclusive.
     */
    "untilDate"?: number;
    /**
     * How many times the downtime is rescheduled.
     * `until_occurences` and `until_date` are mutually exclusive.
     */
    "untilOccurrences"?: number;
    /**
     * A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`.
     * Only applicable when type is weeks. First letter must be capitalized.
     */
    "weekDays"?: Array<string>;
    /**
     * A container for additional, undeclared properties.
     * This is a holder for any undeclared properties as specified with
     * the 'additionalProperties' keyword in the OAS document.
     */
    "additionalProperties"?: {
        [key: string]: any;
    };
    /**
     * @ignore
     */
    "_unparsed"?: boolean;
    /**
     * @ignore
     */
    static readonly attributeTypeMap: AttributeTypeMap;
    /**
     * @ignore
     */
    static getAttributeTypeMap(): AttributeTypeMap;
    constructor();
}