Class GovernanceControlParameterDefinition

The definition of a configurable parameter on a control or mitigation.

Hierarchy

  • GovernanceControlParameterDefinition

Constructors

constructor

Properties

additionalProperties? defaultValue description displayName hidden name required supportedValues type

Constructors

constructor

Properties

Optional additionalProperties

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

defaultValue

defaultValue: any

The default value of the parameter. The JSON type depends on the parameter's type.

description

description: string

A human-readable description of the parameter.

displayName

displayName: string

The human-readable name of the parameter.

hidden

hidden: boolean

Whether the parameter is hidden from the UI.

name

name: string

The machine-readable name of the parameter.

required

required: boolean

Whether the parameter must be provided.

supportedValues

supportedValues: GovernanceControlSupportedValue[]

The supported values for an enumerated parameter.

type

type: string

The type of the parameter, such as integer, string, boolean, enum, or pattern_list.

Settings

Member Visibility

Theme

Generated using TypeDoc