@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
81 lines (80 loc) • 2.84 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 { SecurityMonitoringRuleQueryAggregation } from "./SecurityMonitoringRuleQueryAggregation";
import { SecurityMonitoringStandardDataSource } from "./SecurityMonitoringStandardDataSource";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* Query for matching rule.
*/
export declare class SecurityMonitoringStandardRuleQuery {
/**
* The aggregation type.
*/
"aggregation"?: SecurityMonitoringRuleQueryAggregation;
/**
* Query extension to append to the logs query.
*/
"customQueryExtension"?: string;
/**
* Source of events, either logs, audit trail, or Datadog events.
*/
"dataSource"?: SecurityMonitoringStandardDataSource;
/**
* Field for which the cardinality is measured. Sent as an array.
*/
"distinctFields"?: Array<string>;
/**
* Fields to group by.
*/
"groupByFields"?: Array<string>;
/**
* When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.
*/
"hasOptionalGroupByFields"?: boolean;
/**
* **This field is currently unstable and might be removed in a minor version upgrade.**
* The index to run the query on, if the `dataSource` is `logs`. Only used for scheduled rules - in other words, when the `schedulingOptions` field is present in the rule payload.
*/
"index"?: string;
/**
* (Deprecated) The target field to aggregate over when using the sum or max
* aggregations. `metrics` field should be used instead.
*/
"metric"?: string;
/**
* Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
*/
"metrics"?: Array<string>;
/**
* Name of the query.
*/
"name"?: string;
/**
* Query to run on logs.
*/
"query"?: 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();
}