/** * 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 { AnalysisRequestRuleArgument } from "./AnalysisRequestRuleArgument"; import { AnalysisRequestRuleTest } from "./AnalysisRequestRuleTest"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** * A static analysis rule to apply during code analysis. Clients forward complete rule * objects returned by the rulesets endpoints, so every member of that resource is * declared here; only `id`, `category`, `checksum`, `language`, `severity`, * `tree_sitter_query`, `entity_checked`, `regex`, `type` and `code` are read by this * operation and the rest are ignored. The schema stays open so that any member beyond * the forwarded rule resource is reported as a promotion candidate rather than * rejected; it can be closed once that telemetry confirms none remain. */ export declare class AnalysisRequestRule { /** * The configurable arguments accepted by the rule. Forwarded from the rulesets endpoints; ignored by this operation. */ "arguments"?: Array; /** * The category of the rule (for example, `BEST_PRACTICES`, `SECURITY`). */ "category": string; /** * A checksum of the rule definition. */ "checksum": string; /** * The base64-encoded rule implementation code. */ "code": string; /** * The date and time when the rule was created. Server-assigned by the rulesets endpoints; ignored by this operation. */ "createdAt"?: Date; /** * The identifier of the user or system that created the rule. Server-assigned by the rulesets endpoints; ignored by this operation. */ "createdBy"?: string; /** * The message associated with the custom rule revision. Forwarded from the custom rulesets endpoints; ignored by this operation. */ "creationMessage"?: string; /** * The CVE identifier associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation. */ "cve"?: string; /** * The CWE identifier associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation. */ "cwe"?: string; /** * A detailed explanation of what the rule detects. Forwarded from the rulesets endpoints; ignored by this operation. */ "description"?: string; /** * A URL pointing to the rule documentation. Forwarded from the rulesets endpoints; ignored by this operation. */ "documentationUrl"?: string; /** * The code entity type checked by the rule, applicable when rule type is `AST_CHECK`. */ "entityChecked"?: string; /** * The unique identifier of the rule. */ "id": string; /** * Whether the rule is published. Forwarded from the rulesets endpoints; ignored by this operation. */ "isPublished"?: boolean; /** * Whether the rule is in testing mode. Forwarded from the rulesets endpoints; ignored by this operation. */ "isTesting"?: boolean; /** * The programming language this rule targets. */ "language": string; /** * The date and time when the rule was last modified. Server-assigned by the rulesets endpoints; ignored by this operation. */ "lastUpdatedAt"?: Date; /** * The identifier of the user or system that last updated the rule. Server-assigned by the rulesets endpoints; ignored by this operation. */ "lastUpdatedBy"?: string; /** * The name of the rule. Forwarded from the rulesets endpoints; ignored by this operation. */ "name"?: string; /** * A base64-encoded regex pattern used by the rule, applicable when rule type is `REGEX`. */ "regex"?: string; /** * The severity of findings from this rule (for example, `ERROR`, `WARNING`). */ "severity": string; /** * A brief summary of what the rule detects. Forwarded from the rulesets endpoints; ignored by this operation. */ "shortDescription"?: string; /** * Whether an AI-generated fix should be offered. Forwarded from the rulesets endpoints; ignored by this operation. */ "shouldUseAiFix"?: boolean; /** * Tags associated with the custom rule revision. Forwarded from the custom rulesets endpoints; ignored by this operation. */ "tags"?: Array; /** * The test cases associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation. */ "tests"?: Array; /** * The base64-encoded tree-sitter query used by the rule. */ "treeSitterQuery": string; /** * The rule type indicating the detection mechanism (for example, `TREE_SITTER_QUERY`). */ "type": string; /** * The custom rule revision version. Forwarded from the custom rulesets endpoints; ignored by this operation. */ "versionId"?: 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(); }