@datadog/datadog-api-client/dist/packages/datadog-api-client-v2/models/ObservabilityPipelineQuotaProcessor.d.ts

OpenAPI client for Datadog APIs

/**
 * 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 { ObservabilityPipelineQuotaProcessorLimit } from "./ObservabilityPipelineQuotaProcessorLimit";
import { ObservabilityPipelineQuotaProcessorOverflowAction } from "./ObservabilityPipelineQuotaProcessorOverflowAction";
import { ObservabilityPipelineQuotaProcessorOverride } from "./ObservabilityPipelineQuotaProcessorOverride";
import { ObservabilityPipelineQuotaProcessorType } from "./ObservabilityPipelineQuotaProcessorType";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
 * The Quota Processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.
 */
export declare class ObservabilityPipelineQuotaProcessor {
    /**
     * If set to `true`, logs that matched the quota filter and sent after the quota has been met are dropped; only logs that did not match the filter query continue through the pipeline.
     */
    "dropEvents": boolean;
    /**
     * The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the `input` to downstream components).
     */
    "id": string;
    /**
     * If `true`, the processor skips quota checks when partition fields are missing from the logs.
     */
    "ignoreWhenMissingPartitions"?: boolean;
    /**
     * 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 component.
     */
    "inputs": Array<string>;
    /**
     * The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.
     */
    "limit": ObservabilityPipelineQuotaProcessorLimit;
    /**
     * Name of the quota.
     */
    "name": string;
    /**
     * The action to take when the quota is exceeded. Options:
     * - `drop`: Drop the event.
     * - `no_action`: Let the event pass through.
     * - `overflow_routing`: Route to an overflow destination.
     */
    "overflowAction"?: ObservabilityPipelineQuotaProcessorOverflowAction;
    /**
     * A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.
     */
    "overrides"?: Array<ObservabilityPipelineQuotaProcessorOverride>;
    /**
     * A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.
     */
    "partitionFields"?: Array<string>;
    /**
     * The processor type. The value should always be `quota`.
     */
    "type": ObservabilityPipelineQuotaProcessorType;
    /**
     * 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();
}