DetectorRecipeSummary

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

Bases: object

Summary information for a detector recipe.

Attributes:

DETECTOR_IAAS_ACTIVITY_DETECTOR

A constant which can be used with the detector property of a DetectorRecipeSummary.

DETECTOR_IAAS_CONFIGURATION_DETECTOR

A constant which can be used with the detector property of a DetectorRecipeSummary.

DETECTOR_IAAS_CONTAINER_SECURITY_DETECTOR

A constant which can be used with the detector property of a DetectorRecipeSummary.

DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR

A constant which can be used with the detector property of a DetectorRecipeSummary.

DETECTOR_IAAS_LOG_INSIGHT_DETECTOR

A constant which can be used with the detector property of a DetectorRecipeSummary.

DETECTOR_IAAS_THREAT_DETECTOR

A constant which can be used with the detector property of a DetectorRecipeSummary.

DETECTOR_RECIPE_TYPE_BASIC

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary.

DETECTOR_RECIPE_TYPE_ENTERPRISE

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary.

DETECTOR_RECIPE_TYPE_LIMITED

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary.

DETECTOR_RECIPE_TYPE_STANDARD

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary.

OWNER_CUSTOMER

A constant which can be used with the owner property of a DetectorRecipeSummary.

OWNER_ORACLE

A constant which can be used with the owner property of a DetectorRecipeSummary.

compartment_id

[Required] Gets the compartment_id of this DetectorRecipeSummary.

defined_tags

Gets the defined_tags of this DetectorRecipeSummary.

description

Gets the description of this DetectorRecipeSummary.

detector

[Required] Gets the detector of this DetectorRecipeSummary.

detector_recipe_type

Gets the detector_recipe_type of this DetectorRecipeSummary.

detector_rules

Gets the detector_rules of this DetectorRecipeSummary.

display_name

[Required] Gets the display_name of this DetectorRecipeSummary.

freeform_tags

Gets the freeform_tags of this DetectorRecipeSummary.

id

[Required] Gets the id of this DetectorRecipeSummary.

lifecycle_state

Gets the lifecycle_state of this DetectorRecipeSummary.

owner

[Required] Gets the owner of this DetectorRecipeSummary.

source_data_retention

Gets the source_data_retention of this DetectorRecipeSummary.

source_detector_recipe_id

Gets the source_detector_recipe_id of this DetectorRecipeSummary.

system_tags

Gets the system_tags of this DetectorRecipeSummary.

time_created

Gets the time_created of this DetectorRecipeSummary.

time_updated

Gets the time_updated of this DetectorRecipeSummary.

Methods:

__init__(**kwargs)

Initializes a new DetectorRecipeSummary object with values from keyword arguments.

DETECTOR_IAAS_ACTIVITY_DETECTOR = 'IAAS_ACTIVITY_DETECTOR'

A constant which can be used with the detector property of a DetectorRecipeSummary. This constant has a value of “IAAS_ACTIVITY_DETECTOR”

DETECTOR_IAAS_CONFIGURATION_DETECTOR = 'IAAS_CONFIGURATION_DETECTOR'

A constant which can be used with the detector property of a DetectorRecipeSummary. This constant has a value of “IAAS_CONFIGURATION_DETECTOR”

DETECTOR_IAAS_CONTAINER_SECURITY_DETECTOR = 'IAAS_CONTAINER_SECURITY_DETECTOR'

A constant which can be used with the detector property of a DetectorRecipeSummary. This constant has a value of “IAAS_CONTAINER_SECURITY_DETECTOR”

DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR = 'IAAS_INSTANCE_SECURITY_DETECTOR'

A constant which can be used with the detector property of a DetectorRecipeSummary. This constant has a value of “IAAS_INSTANCE_SECURITY_DETECTOR”

DETECTOR_IAAS_LOG_INSIGHT_DETECTOR = 'IAAS_LOG_INSIGHT_DETECTOR'

A constant which can be used with the detector property of a DetectorRecipeSummary. This constant has a value of “IAAS_LOG_INSIGHT_DETECTOR”

DETECTOR_IAAS_THREAT_DETECTOR = 'IAAS_THREAT_DETECTOR'

A constant which can be used with the detector property of a DetectorRecipeSummary. This constant has a value of “IAAS_THREAT_DETECTOR”

DETECTOR_RECIPE_TYPE_BASIC = 'BASIC'

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary. This constant has a value of “BASIC”

DETECTOR_RECIPE_TYPE_ENTERPRISE = 'ENTERPRISE'

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary. This constant has a value of “ENTERPRISE”

DETECTOR_RECIPE_TYPE_LIMITED = 'LIMITED'

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary. This constant has a value of “LIMITED”

DETECTOR_RECIPE_TYPE_STANDARD = 'STANDARD'

A constant which can be used with the detector_recipe_type property of a DetectorRecipeSummary. This constant has a value of “STANDARD”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. This constant has a value of “UPDATING”

OWNER_CUSTOMER = 'CUSTOMER'

A constant which can be used with the owner property of a DetectorRecipeSummary. This constant has a value of “CUSTOMER”

OWNER_ORACLE = 'ORACLE'

A constant which can be used with the owner property of a DetectorRecipeSummary. This constant has a value of “ORACLE”

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this DetectorRecipeSummary.

  • display_name (str) – The value to assign to the display_name property of this DetectorRecipeSummary.

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

  • compartment_id (str) – The value to assign to the compartment_id property of this DetectorRecipeSummary.

  • source_detector_recipe_id (str) – The value to assign to the source_detector_recipe_id property of this DetectorRecipeSummary.

  • owner (str) – The value to assign to the owner property of this DetectorRecipeSummary. Allowed values for this property are: “CUSTOMER”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • detector_recipe_type (str) – The value to assign to the detector_recipe_type property of this DetectorRecipeSummary. Allowed values for this property are: “LIMITED”, “BASIC”, “STANDARD”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • detector (str) – The value to assign to the detector property of this DetectorRecipeSummary. Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”, “IAAS_CONTAINER_SECURITY_DETECTOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • detector_rules (list[oci.cloud_guard.models.DetectorRecipeDetectorRule]) – The value to assign to the detector_rules property of this DetectorRecipeSummary.

  • time_created (datetime) – The value to assign to the time_created property of this DetectorRecipeSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this DetectorRecipeSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DetectorRecipeSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • source_data_retention (int) – The value to assign to the source_data_retention property of this DetectorRecipeSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DetectorRecipeSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DetectorRecipeSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DetectorRecipeSummary.

property compartment_id

[Required] Gets the compartment_id of this DetectorRecipeSummary. Compartment OCID of detector recipe

Returns

The compartment_id of this DetectorRecipeSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DetectorRecipeSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this DetectorRecipeSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this DetectorRecipeSummary. Detector recipe description

Returns

The description of this DetectorRecipeSummary.

Return type

str

property detector

[Required] Gets the detector of this DetectorRecipeSummary. Type of detector

Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”, “IAAS_CONTAINER_SECURITY_DETECTOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The detector of this DetectorRecipeSummary.

Return type

str

property detector_recipe_type

Gets the detector_recipe_type of this DetectorRecipeSummary. Recipe type ( STANDARD, ENTERPRISE )

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

Returns

The detector_recipe_type of this DetectorRecipeSummary.

Return type

str

property detector_rules

Gets the detector_rules of this DetectorRecipeSummary. List of detector rules for the detector type

Returns

The detector_rules of this DetectorRecipeSummary.

Return type

list[oci.cloud_guard.models.DetectorRecipeDetectorRule]

property display_name

[Required] Gets the display_name of this DetectorRecipeSummary. Display name for detector recipe

Returns

The display_name of this DetectorRecipeSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DetectorRecipeSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Avoid entering confidential information.

Returns

The freeform_tags of this DetectorRecipeSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this DetectorRecipeSummary. OCID for detector recipe

Returns

The id of this DetectorRecipeSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this DetectorRecipeSummary. The current lifecycle state of the resource

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this DetectorRecipeSummary.

Return type

str

property owner

[Required] Gets the owner of this DetectorRecipeSummary. Owner of the detector recipe

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

Returns

The owner of this DetectorRecipeSummary.

Return type

str

property source_data_retention

Gets the source_data_retention of this DetectorRecipeSummary. The number of days for which source data is retained

Returns

The source_data_retention of this DetectorRecipeSummary.

Return type

int

property source_detector_recipe_id

Gets the source_detector_recipe_id of this DetectorRecipeSummary. Recipe OCID of the source recipe to be cloned

Returns

The source_detector_recipe_id of this DetectorRecipeSummary.

Return type

str

property system_tags

Gets the system_tags of this DetectorRecipeSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DetectorRecipeSummary.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this DetectorRecipeSummary. The date and time the detector recipe was created. Format defined by RFC3339.

Returns

The time_created of this DetectorRecipeSummary.

Return type

datetime

property time_updated

Gets the time_updated of this DetectorRecipeSummary. The date and time the detector recipe was last updated. Format defined by RFC3339.

Returns

The time_updated of this DetectorRecipeSummary.

Return type

datetime