DetectorDetails

class oci.cloud_guard.models.DetectorDetails(**kwargs)

Bases: object

Detailed information for a detector.

Attributes:

RISK_LEVEL_CRITICAL

A constant which can be used with the risk_level property of a DetectorDetails.

RISK_LEVEL_HIGH

A constant which can be used with the risk_level property of a DetectorDetails.

RISK_LEVEL_LOW

A constant which can be used with the risk_level property of a DetectorDetails.

RISK_LEVEL_MEDIUM

A constant which can be used with the risk_level property of a DetectorDetails.

RISK_LEVEL_MINOR

A constant which can be used with the risk_level property of a DetectorDetails.

condition

Gets the condition of this DetectorDetails.

configurations

Gets the configurations of this DetectorDetails.

data_source_id

Gets the data_source_id of this DetectorDetails.

description

Gets the description of this DetectorDetails.

entities_mappings

Gets the entities_mappings of this DetectorDetails.

is_configuration_allowed

Gets the is_configuration_allowed of this DetectorDetails.

is_enabled

[Required] Gets the is_enabled of this DetectorDetails.

labels

Gets the labels of this DetectorDetails.

problem_threshold

Gets the problem_threshold of this DetectorDetails.

recommendation

Gets the recommendation of this DetectorDetails.

risk_level

Gets the risk_level of this DetectorDetails.

sighting_types

Gets the sighting_types of this DetectorDetails.

target_types

Gets the target_types of this DetectorDetails.

Methods:

__init__(**kwargs)

Initializes a new DetectorDetails object with values from keyword arguments.

RISK_LEVEL_CRITICAL = 'CRITICAL'

A constant which can be used with the risk_level property of a DetectorDetails. This constant has a value of “CRITICAL”

RISK_LEVEL_HIGH = 'HIGH'

A constant which can be used with the risk_level property of a DetectorDetails. This constant has a value of “HIGH”

RISK_LEVEL_LOW = 'LOW'

A constant which can be used with the risk_level property of a DetectorDetails. This constant has a value of “LOW”

RISK_LEVEL_MEDIUM = 'MEDIUM'

A constant which can be used with the risk_level property of a DetectorDetails. This constant has a value of “MEDIUM”

RISK_LEVEL_MINOR = 'MINOR'

A constant which can be used with the risk_level property of a DetectorDetails. This constant has a value of “MINOR”

__init__(**kwargs)

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

Parameters
  • is_enabled (bool) – The value to assign to the is_enabled property of this DetectorDetails.

  • risk_level (str) – The value to assign to the risk_level property of this DetectorDetails. Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “MINOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • configurations (list[oci.cloud_guard.models.DetectorConfiguration]) – The value to assign to the configurations property of this DetectorDetails.

  • condition (oci.cloud_guard.models.Condition) – The value to assign to the condition property of this DetectorDetails.

  • labels (list[str]) – The value to assign to the labels property of this DetectorDetails.

  • is_configuration_allowed (bool) – The value to assign to the is_configuration_allowed property of this DetectorDetails.

  • problem_threshold (int) – The value to assign to the problem_threshold property of this DetectorDetails.

  • target_types (list[str]) – The value to assign to the target_types property of this DetectorDetails.

  • sighting_types (list[oci.cloud_guard.models.SightingType]) – The value to assign to the sighting_types property of this DetectorDetails.

  • description (str) – The value to assign to the description property of this DetectorDetails.

  • recommendation (str) – The value to assign to the recommendation property of this DetectorDetails.

  • data_source_id (str) – The value to assign to the data_source_id property of this DetectorDetails.

  • entities_mappings (list[oci.cloud_guard.models.EntitiesMapping]) – The value to assign to the entities_mappings property of this DetectorDetails.

property condition

Gets the condition of this DetectorDetails.

Returns

The condition of this DetectorDetails.

Return type

oci.cloud_guard.models.Condition

property configurations

Gets the configurations of this DetectorDetails. List of detector rule configurations

Returns

The configurations of this DetectorDetails.

Return type

list[oci.cloud_guard.models.DetectorConfiguration]

property data_source_id

Gets the data_source_id of this DetectorDetails. The ID of the attached data source

Returns

The data_source_id of this DetectorDetails.

Return type

str

property description

Gets the description of this DetectorDetails. Description for detector recipe detector rule

Returns

The description of this DetectorDetails.

Return type

str

property entities_mappings

Gets the entities_mappings of this DetectorDetails. Data source entities mapping for a detector rule

Returns

The entities_mappings of this DetectorDetails.

Return type

list[oci.cloud_guard.models.EntitiesMapping]

property is_configuration_allowed

Gets the is_configuration_allowed of this DetectorDetails. Can the rule be configured?

Returns

The is_configuration_allowed of this DetectorDetails.

Return type

bool

property is_enabled

[Required] Gets the is_enabled of this DetectorDetails. Enablement status for the rule

Returns

The is_enabled of this DetectorDetails.

Return type

bool

property labels

Gets the labels of this DetectorDetails. User-defined labels for a detector rule

Returns

The labels of this DetectorDetails.

Return type

list[str]

property problem_threshold

Gets the problem_threshold of this DetectorDetails. The point at which an elevated resource risk score creates a problem

Returns

The problem_threshold of this DetectorDetails.

Return type

int

property recommendation

Gets the recommendation of this DetectorDetails. Recommendation for detector recipe detector rule

Returns

The recommendation of this DetectorDetails.

Return type

str

property risk_level

Gets the risk_level of this DetectorDetails. The risk level for the rule

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

Returns

The risk_level of this DetectorDetails.

Return type

str

property sighting_types

Gets the sighting_types of this DetectorDetails. List of sighting types

Returns

The sighting_types of this DetectorDetails.

Return type

list[oci.cloud_guard.models.SightingType]

property target_types

Gets the target_types of this DetectorDetails. List of target types for which the detector rule is applicable

Returns

The target_types of this DetectorDetails.

Return type

list[str]