The attributes of a governance insight.

Hierarchy

  • GovernanceInsightAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

An audit log query used to compute an insight value.

The best practice associated with an insight. Populated with the first active best practice matched to the insight; null when no best practice is attached.

deepLink: string

A relative link to the product surface where the insight can be acted upon.

description: string

A human-readable description of what the insight measures.

displayName: string

Human-readable name of the insight.

An event query used to compute an insight value.

A metric query used to compute an insight value.

oldValue: null | number

The value of the insight over the previous comparison window. null when values were not requested or could not be computed.

A percentage query that computes an insight value as a ratio of two metric queries.

product: string

The product the insight belongs to.

Query execution context that allows the frontend to execute insight queries directly.

sortOrder?: number

The relative order in which the insight should be displayed.

state: string

The state of the insight. A critical insight receives extra UI treatment to draw attention to it.

subProduct: string

The sub-product the insight belongs to, if any.

timeRange: string

The time range the insight value is computed over, if applicable.

unitName: string

The unit that the insight's value is measured in.

A usage query used to compute an insight value.

value: null | number

The current value of the insight. null when values were not requested or could not be computed.

Generated using TypeDoc