@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
62 lines (61 loc) • 2 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 { ObservabilityPipelineThrottleProcessorType } from "./ObservabilityPipelineThrottleProcessorType";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* The `throttle` processor limits the number of events that pass through over a given time window.
*/
export declare class ObservabilityPipelineThrottleProcessor {
/**
* Optional list of fields used to group events before the threshold has been reached.
*/
"groupBy"?: Array<string>;
/**
* The unique identifier for this processor.
*/
"id": string;
/**
* A Datadog search query used to determine which logs this processor targets.
*/
"include": string;
/**
* A list of component IDs whose output is used as the input for this processor.
*/
"inputs": Array<string>;
/**
* the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.
*/
"threshold": number;
/**
* The processor type. The value should always be `throttle`.
*/
"type": ObservabilityPipelineThrottleProcessorType;
/**
* The time window in seconds over which the threshold applies.
*/
"window": number;
/**
* 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();
}