Interface CheckBase

interface CheckBase {
    createdAt?: string;
    description?: string;
    id?: string;
    labels?: Labels;
    lastRunError?: string;
    lastRunStatus?: "failed" | "success" | "canceled";
    latestCompleted?: string;
    links?: {
        labels?: string;
        members?: string;
        owners?: string;
        query?: string;
        self?: string;
    };
    name: string;
    orgID: string;
    ownerID?: string;
    query: DashboardQuery;
    status?: TaskStatusType;
    taskID?: string;
    updatedAt?: string;
}

Properties

createdAt? description? id? labels? lastRunError? lastRunStatus? latestCompleted? links? name orgID ownerID? query status? taskID? updatedAt?

Properties

Optional ReadonlycreatedAt

createdAt?: string

Optionaldescription

description?: string

An optional description of the check.

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.

Optional Readonlylinks

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

Type declaration

  • Optionallabels?: string

    URL to retrieve labels for this check

  • Optionalmembers?: string

    URL to retrieve members for this check

  • Optionalowners?: string

    URL to retrieve owners for this check

  • Optionalquery?: string

    URL to retrieve flux script for this check

  • Optionalself?: string

    URL for this check

name

name: string

orgID

orgID: string

The ID of the organization that owns this check.

Optional ReadonlyownerID

ownerID?: string

The ID of creator used to create this check.

query

query: DashboardQuery

Optionalstatus

status?: TaskStatusType

OptionaltaskID

taskID?: string

The ID of the task associated with this check.

Optional ReadonlyupdatedAt

updatedAt?: string

Settings

Member Visibility

On This Page

Properties