Interface NotificationRuleBase

interface NotificationRuleBase {
    createdAt?: string;
    description?: string;
    endpointID: string;
    every?: string;
    id?: string;
    labels?: Labels;
    lastRunError?: string;
    lastRunStatus?: "failed" | "success" | "canceled";
    latestCompleted?: string;
    limit?: number;
    limitEvery?: number;
    links?: {
        labels?: string;
        members?: string;
        owners?: string;
        query?: string;
        self?: string;
    };
    name: string;
    offset?: string;
    orgID: string;
    ownerID?: string;
    runbookLink?: string;
    sleepUntil?: string;
    status: TaskStatusType;
    statusRules: StatusRule[];
    tagRules?: TagRule[];
    taskID?: string;
    updatedAt?: string;
}

Properties

createdAt? description? endpointID every? id? labels? lastRunError? lastRunStatus? latestCompleted? limit? limitEvery? links? name offset? orgID ownerID? runbookLink? sleepUntil? status statusRules tagRules? taskID? updatedAt?

Properties

Optional ReadonlycreatedAt

createdAt?: string

Optionaldescription

description?: string

An optional description of the notification rule.

endpointID

endpointID: string

Optionalevery

every?: string

The notification repetition interval.

Optional Readonlyid

id?: string

Optionallabels

labels?: Labels

Optional ReadonlylastRunError

lastRunError?: string

Optional ReadonlylastRunStatus

lastRunStatus?: "failed" | "success" | "canceled"

Optional ReadonlylatestCompleted

latestCompleted?: string

A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

Optionallimit

limit?: number

Don't notify me more than times every seconds. If set, limitEvery cannot be empty.

OptionallimitEvery

limitEvery?: number

Don't notify me more than times every seconds. If set, limit cannot be empty.

Optional Readonlylinks

links?: {
    labels?: string;
    members?: string;
    owners?: string;
    query?: string;
    self?: string;
}

Type declaration

  • Optionallabels?: string

    URL to retrieve labels for this notification rule.

  • Optionalmembers?: string

    URL to retrieve members for this notification rule.

  • Optionalowners?: string

    URL to retrieve owners for this notification rule.

  • Optionalquery?: string

    URL to retrieve flux script for this notification rule.

  • Optionalself?: string

    URL for this endpoint.

name

name: string

Human-readable name describing the notification rule.

Optionaloffset

offset?: string

Duration to delay after the schedule, before executing check.

orgID

orgID: string

The ID of the organization that owns this notification rule.

Optional ReadonlyownerID

ownerID?: string

The ID of creator used to create this notification rule.

OptionalrunbookLink

runbookLink?: string

OptionalsleepUntil

sleepUntil?: string

status

status: TaskStatusType

statusRules

statusRules: StatusRule[]

List of status rules the notification rule attempts to match.

OptionaltagRules

tagRules?: TagRule[]

List of tag rules the notification rule attempts to match.

OptionaltaskID

taskID?: string

The ID of the task associated with this notification rule.

Optional ReadonlyupdatedAt

updatedAt?: string

Settings

Member Visibility

On This Page

Properties