@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
92 lines (91 loc) • 3.43 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 { HostMapRequest } from "./HostMapRequest";
import { HostMapWidgetGroupBy } from "./HostMapWidgetGroupBy";
import { HostMapWidgetInfrastructureRequest } from "./HostMapWidgetInfrastructureRequest";
import { HostMapWidgetInfrastructureRequestRequestType } from "./HostMapWidgetInfrastructureRequestRequestType";
import { HostMapWidgetInfrastructureStyle } from "./HostMapWidgetInfrastructureStyle";
import { HostMapWidgetNodeType } from "./HostMapWidgetNodeType";
import { HostMapWidgetScalarRequest } from "./HostMapWidgetScalarRequest";
import { WidgetConditionalFormat } from "./WidgetConditionalFormat";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* Query definition for the host map widget. Supports two mutually exclusive formats distinguished by the presence of `request_type`: the legacy metric-based format (`fill`/`size`) and the infrastructure-backed format (`request_type`, `node_type`, `enrichments`).
*/
export declare class HostMapWidgetDefinitionRequests {
/**
* Infrastructure-backed request for the host map widget. Supports entity-based
* visualization with metric query enrichments, tag-based filtering, flexible grouping,
* and hierarchical views.
*/
"child"?: HostMapWidgetInfrastructureRequest;
/**
* List of conditional formatting rules applied to fill values.
*/
"conditionalFormats"?: Array<WidgetConditionalFormat>;
/**
* Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
*/
"enrichments"?: Array<HostMapWidgetScalarRequest>;
/**
* Updated host map.
*/
"fill"?: HostMapRequest;
/**
* Filter string for the entity set in tag format (for example, `env:prod`).
*/
"filter"?: string;
/**
* Defines how entities are grouped into tiles. The ordering of entries implies
* the grouping hierarchy.
*/
"groupBy"?: Array<HostMapWidgetGroupBy>;
/**
* Whether to hide entities that have no group assignment.
*/
"noGroupHosts"?: boolean;
/**
* Whether to hide entities that have no enrichment data.
*/
"noMetricHosts"?: boolean;
/**
* Which type of infrastructure entity to visualize in the host map.
*/
"nodeType"?: HostMapWidgetNodeType;
/**
* Identifies this as an infrastructure-backed host map request.
*/
"requestType"?: HostMapWidgetInfrastructureRequestRequestType;
/**
* Updated host map.
*/
"size"?: HostMapRequest;
/**
* Style configuration for the infrastructure host map.
*/
"style"?: HostMapWidgetInfrastructureStyle;
/**
* 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();
}