DetectConfiguration¶

class oci.adm.models.DetectConfiguration(**kwargs)¶

Bases: object

A configuration to define the constraints when detecting vulnerable dependencies and recommending remediations.

Attributes

`MAX_PERMISSIBLE_SEVERITY_CRITICAL`	A constant which can be used with the max_permissible_severity property of a DetectConfiguration.
`MAX_PERMISSIBLE_SEVERITY_HIGH`	A constant which can be used with the max_permissible_severity property of a DetectConfiguration.
`MAX_PERMISSIBLE_SEVERITY_LOW`	A constant which can be used with the max_permissible_severity property of a DetectConfiguration.
`MAX_PERMISSIBLE_SEVERITY_MEDIUM`	A constant which can be used with the max_permissible_severity property of a DetectConfiguration.
`MAX_PERMISSIBLE_SEVERITY_NONE`	A constant which can be used with the max_permissible_severity property of a DetectConfiguration.
`MAX_PERMISSIBLE_SEVERITY_UNSET`	A constant which can be used with the max_permissible_severity property of a DetectConfiguration.
`UPGRADE_POLICY_NEAREST`	A constant which can be used with the upgrade_policy property of a DetectConfiguration.
`exclusions`	Gets the exclusions of this DetectConfiguration.
`max_permissible_cvss_v2_score`	Gets the max_permissible_cvss_v2_score of this DetectConfiguration.
`max_permissible_cvss_v3_score`	Gets the max_permissible_cvss_v3_score of this DetectConfiguration.
`max_permissible_severity`	Gets the max_permissible_severity of this DetectConfiguration.
`upgrade_policy`	Gets the upgrade_policy of this DetectConfiguration.

Methods

__init__(**kwargs) Initializes a new DetectConfiguration object with values from keyword arguments.

MAX_PERMISSIBLE_SEVERITY_CRITICAL = 'CRITICAL'¶: A constant which can be used with the max_permissible_severity property of a DetectConfiguration. This constant has a value of “CRITICAL”

MAX_PERMISSIBLE_SEVERITY_HIGH = 'HIGH'¶: A constant which can be used with the max_permissible_severity property of a DetectConfiguration. This constant has a value of “HIGH”

MAX_PERMISSIBLE_SEVERITY_LOW = 'LOW'¶: A constant which can be used with the max_permissible_severity property of a DetectConfiguration. This constant has a value of “LOW”

MAX_PERMISSIBLE_SEVERITY_MEDIUM = 'MEDIUM'¶: A constant which can be used with the max_permissible_severity property of a DetectConfiguration. This constant has a value of “MEDIUM”

MAX_PERMISSIBLE_SEVERITY_NONE = 'NONE'¶: A constant which can be used with the max_permissible_severity property of a DetectConfiguration. This constant has a value of “NONE”

MAX_PERMISSIBLE_SEVERITY_UNSET = 'UNSET'¶: A constant which can be used with the max_permissible_severity property of a DetectConfiguration. This constant has a value of “UNSET”

UPGRADE_POLICY_NEAREST = 'NEAREST'¶: A constant which can be used with the upgrade_policy property of a DetectConfiguration. This constant has a value of “NEAREST”

__init__(**kwargs)¶

Initializes a new DetectConfiguration object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

exclusions (list[str]) – The value to assign to the exclusions property of this DetectConfiguration.
upgrade_policy (str) – The value to assign to the upgrade_policy property of this DetectConfiguration. Allowed values for this property are: “NEAREST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
max_permissible_cvss_v2_score (float) – The value to assign to the max_permissible_cvss_v2_score property of this DetectConfiguration.
max_permissible_cvss_v3_score (float) – The value to assign to the max_permissible_cvss_v3_score property of this DetectConfiguration.
max_permissible_severity (str) – The value to assign to the max_permissible_severity property of this DetectConfiguration. Allowed values for this property are: “UNSET”, “NONE”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

exclusions¶

Gets the exclusions of this DetectConfiguration. The list of dependencies to be ignored by the recommendation algorithm. The dependency pattern is matched against the ‘group:artifact:version’ or the purl of a dependency. An asterisk (*) at the end in the dependency pattern acts as a wildcard and matches zero or more characters.

Returns:	The exclusions of this DetectConfiguration.
Return type:	list[str]

max_permissible_cvss_v2_score¶

Gets the max_permissible_cvss_v2_score of this DetectConfiguration. The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score. A vulnerability with a CVSS V2 score below this value is not considered for remediation.

Returns:	The max_permissible_cvss_v2_score of this DetectConfiguration.
Return type:	float

max_permissible_cvss_v3_score¶

Gets the max_permissible_cvss_v3_score of this DetectConfiguration. The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score. A vulnerability with a CVSS V3 score below this value is not considered for patching.

Returns:	The max_permissible_cvss_v3_score of this DetectConfiguration.
Return type:	float

max_permissible_severity¶

Gets the max_permissible_severity of this DetectConfiguration. The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation.

Allowed values for this property are: “UNSET”, “NONE”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The max_permissible_severity of this DetectConfiguration.
Return type:	str

upgrade_policy¶

Gets the upgrade_policy of this DetectConfiguration. The upgrade policy for recommendations. The Nearest upgrade policy upgrades a dependency to the oldest version that meets both of the following criteria: it is newer than the current version and it is not affected by a vulnerability.

Allowed values for this property are: “NEAREST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The upgrade_policy of this DetectConfiguration.
Return type:	str