@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
113 lines (112 loc) • 3.61 kB
TypeScript
/**
* 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 { DashboardGlobalTime } from "./DashboardGlobalTime";
import { DashboardShareType } from "./DashboardShareType";
import { DashboardType } from "./DashboardType";
import { SelectableTemplateVariableItems } from "./SelectableTemplateVariableItems";
import { SharedDashboardAuthor } from "./SharedDashboardAuthor";
import { SharedDashboardInviteesItems } from "./SharedDashboardInviteesItems";
import { SharedDashboardStatus } from "./SharedDashboardStatus";
import { ViewingPreferences } from "./ViewingPreferences";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* The metadata object associated with how a dashboard has been/will be shared.
*/
export declare class SharedDashboard {
/**
* User who shared the dashboard.
*/
"author"?: SharedDashboardAuthor;
/**
* Date the dashboard was shared.
*/
"created"?: Date;
/**
* ID of the dashboard to share.
*/
"dashboardId": string;
/**
* The type of the associated private dashboard.
*/
"dashboardType": DashboardType;
/**
* The `SharedDashboard` `embeddable_domains`.
*/
"embeddableDomains"?: Array<string>;
/**
* The time when an OPEN shared dashboard becomes publicly unavailable.
*/
"expiration"?: Date;
/**
* Object containing the live span selection for the dashboard.
*/
"globalTime"?: DashboardGlobalTime;
/**
* Whether to allow viewers to select a different global time setting for the shared dashboard.
*/
"globalTimeSelectableEnabled"?: boolean;
/**
* The `SharedDashboard` `invitees`.
*/
"invitees"?: Array<SharedDashboardInviteesItems>;
/**
* The last time the shared dashboard was accessed. Null if never accessed.
*/
"lastAccessed"?: Date;
/**
* URL of the shared dashboard.
*/
"publicUrl"?: string;
/**
* List of objects representing template variables on the shared dashboard which can have selectable values.
*/
"selectableTemplateVars"?: Array<SelectableTemplateVariableItems>;
/**
* List of email addresses that can receive an invitation to access to the shared dashboard.
*/
"shareList"?: Array<string>;
/**
* Type of sharing access (either open to anyone who has the public URL or invite-only).
*/
"shareType"?: DashboardShareType;
/**
* Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.
*/
"status"?: SharedDashboardStatus;
/**
* Title of the shared dashboard.
*/
"title"?: string;
/**
* A unique token assigned to the shared dashboard.
*/
"token"?: string;
/**
* The viewing preferences for a shared dashboard.
*/
"viewingPreferences"?: ViewingPreferences;
/**
* 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();
}