Rule

import type { Rule } from "https://googleapis.deno.dev/v1/workloadmanager:v1.ts";

A rule to be evaluated.

interface Rule {

assetType?: string;

description?: string;

displayName?: string;

errorMessage?: string;

name?: string;

primaryCategory?: string;

remediation?: string;

readonly revisionId?: string;

ruleType?: "RULE_TYPE_UNSPECIFIED" | "BASELINE" | "CUSTOM";

secondaryCategory?: string;

severity?: string;

tags?: string[];

uri?: string;

}

§Properties

assetType?: string

[src]

The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.

description?: string

[src]

Describe rule in plain language.

displayName?: string

[src]

The name display in UI.

errorMessage?: string

[src]

The message template for rule.

name?: string

[src]

Rule name.

primaryCategory?: string

[src]

The primary category.

remediation?: string

[src]

The remediation for the rule.

readonly revisionId?: string

[src]

Output only. The version of the rule.

ruleType?: "RULE_TYPE_UNSPECIFIED" | "BASELINE" | "CUSTOM"

[src]

The type of the rule.

secondaryCategory?: string

[src]

The secondary category.

severity?: string

[src]

The severity of the rule.

tags?: string[]

[src]

List of user-defined tags.

uri?: string

[src]

The document url for the rule.