Alert

import type { Alert } from "https://googleapis.deno.dev/v1/threatintelligence:v1beta.ts";

Stateful object representing a group of Findings. Key feature to an Alert is that it expresses the user's intent towards the findings of that group, even those that haven't occurred yet.

interface Alert {

aiSummary?: string;

readonly assets?: string[];

readonly audit?: Audit;

readonly configurations?: string[];

readonly detail?: AlertDetail;

readonly displayName?: string;

readonly duplicatedBy?: string[];

readonly duplicateOf?: string;

etag?: string;

readonly externalId?: string;

readonly findings?: string[];

name?: string;

readonly priorityAnalysis?: PriorityAnalysis;

readonly relevanceAnalysis?: RelevanceAnalysis;

readonly severityAnalysis?: SeverityAnalysis;

readonly state?:

| "STATE_UNSPECIFIED"

| "NEW"

| "READ"

| "TRIAGED"

| "ESCALATED"

| "RESOLVED"

| "DUPLICATE"

| "FALSE_POSITIVE"

| "NOT_ACTIONABLE"

| "BENIGN"

| "TRACKED_EXTERNALLY";

}

§Properties

aiSummary?: string

[src]

Optional. AI summary of the finding.

readonly assets?: string[]

[src]

Output only. Assets that are impacted by this alert.

readonly audit?: Audit

[src]

Output only. Audit information for the alert.

readonly configurations?: string[]

[src]

Output only. The resource names of the Configurations bound to this alert. Format: projects/{project}/configurations/{configuration}

readonly detail?: AlertDetail

[src]

Output only. Details object for the alert, not all alerts will have a details object.

readonly displayName?: string

[src]

Output only. A short title for the alert.

readonly duplicatedBy?: string[]

[src]

Output only. alert names of the alerts that are duplicates of this alert. Format: projects/{project}/alerts/{alert}

readonly duplicateOf?: string

[src]

Output only. alert name of the alert this alert is a duplicate of. Format: projects/{project}/alerts/{alert}

etag?: string

[src]

Optional. If included when updating an alert, this should be set to the current etag of the alert. If the etags do not match, the update will be rejected and an ABORTED error will be returned.

readonly externalId?: string

[src]

Output only. External ID for the alert. This is used internally to provide protection against out of order updates.

readonly findings?: string[]

[src]

Output only. Findings that are covered by this alert.

name?: string

[src]

Identifier. Server generated name for the alert. format is projects/{project}/alerts/{alert}

readonly priorityAnalysis?: PriorityAnalysis

[src]

Output only. High-Precision Priority Analysis for the alert.