FindingSummary¶
- class oci.data_safe.models.FindingSummary(**kwargs)¶
Bases:
objectThe particular finding reported by the security assessment.
Attributes:
A constant which can be used with the lifecycle_state property of a FindingSummary.
A constant which can be used with the lifecycle_state property of a FindingSummary.
A constant which can be used with the lifecycle_state property of a FindingSummary.
A constant which can be used with the lifecycle_state property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
A constant which can be used with the severity property of a FindingSummary.
Gets the assessment_id of this FindingSummary.
Gets the category of this FindingSummary.
Gets the details of this FindingSummary.
Gets the doclink of this FindingSummary.
Gets the has_target_db_risk_level_changed of this FindingSummary.
Gets the is_risk_modified of this FindingSummary.
Gets the is_top_finding of this FindingSummary.
Gets the justification of this FindingSummary.
Gets the key of this FindingSummary.
Gets the lifecycle_details of this FindingSummary.
Gets the lifecycle_state of this FindingSummary.
Gets the oneline of this FindingSummary.
Gets the oracle_defined_severity of this FindingSummary.
Gets the references of this FindingSummary.
Gets the remarks of this FindingSummary.
Gets the severity of this FindingSummary.
Gets the summary of this FindingSummary.
Gets the target_id of this FindingSummary.
Gets the time_updated of this FindingSummary.
Gets the time_valid_until of this FindingSummary.
Gets the title of this FindingSummary.
Methods:
__init__(**kwargs)Initializes a new FindingSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a FindingSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a FindingSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a FindingSummary. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a FindingSummary. This constant has a value of “UPDATING”
- SEVERITY_ADVISORY = 'ADVISORY'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “ADVISORY”
- SEVERITY_DEFERRED = 'DEFERRED'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “DEFERRED”
- SEVERITY_EVALUATE = 'EVALUATE'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “EVALUATE”
- SEVERITY_HIGH = 'HIGH'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “HIGH”
- SEVERITY_LOW = 'LOW'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “LOW”
- SEVERITY_MEDIUM = 'MEDIUM'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “MEDIUM”
- SEVERITY_PASS = 'PASS'¶
A constant which can be used with the severity property of a FindingSummary. This constant has a value of “PASS”
- __init__(**kwargs)¶
Initializes a new FindingSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
severity (str) – The value to assign to the severity property of this FindingSummary. Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, “ADVISORY”, “PASS”, “DEFERRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
assessment_id (str) – The value to assign to the assessment_id property of this FindingSummary.
target_id (str) – The value to assign to the target_id property of this FindingSummary.
key (str) – The value to assign to the key property of this FindingSummary.
is_top_finding (bool) – The value to assign to the is_top_finding property of this FindingSummary.
title (str) – The value to assign to the title property of this FindingSummary.
category (str) – The value to assign to the category property of this FindingSummary.
remarks (str) – The value to assign to the remarks property of this FindingSummary.
details (object) – The value to assign to the details property of this FindingSummary.
summary (str) – The value to assign to the summary property of this FindingSummary.
oneline (str) – The value to assign to the oneline property of this FindingSummary.
doclink (str) – The value to assign to the doclink property of this FindingSummary.
references (oci.data_safe.models.References) – The value to assign to the references property of this FindingSummary.
oracle_defined_severity (str) – The value to assign to the oracle_defined_severity property of this FindingSummary.
is_risk_modified (bool) – The value to assign to the is_risk_modified property of this FindingSummary.
has_target_db_risk_level_changed (bool) – The value to assign to the has_target_db_risk_level_changed property of this FindingSummary.
justification (str) – The value to assign to the justification property of this FindingSummary.
time_valid_until (datetime) – The value to assign to the time_valid_until property of this FindingSummary.
time_updated (datetime) – The value to assign to the time_updated property of this FindingSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FindingSummary. Allowed values for this property are: “ACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this FindingSummary.
- property assessment_id¶
Gets the assessment_id of this FindingSummary. The OCID of the assessment that generated this finding.
- Returns
The assessment_id of this FindingSummary.
- Return type
str
- property category¶
Gets the category of this FindingSummary. The category to which the finding belongs to.
- Returns
The category of this FindingSummary.
- Return type
str
- property details¶
Gets the details of this FindingSummary. The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes.
- Returns
The details of this FindingSummary.
- Return type
object
- property doclink¶
Gets the doclink of this FindingSummary. Documentation link provided by Oracle that explains a specific security finding or check.
- Returns
The doclink of this FindingSummary.
- Return type
str
- property has_target_db_risk_level_changed¶
Gets the has_target_db_risk_level_changed of this FindingSummary. Determines if this risk level has changed on the target database since the last time ‘severity’ was modified by user.
- Returns
The has_target_db_risk_level_changed of this FindingSummary.
- Return type
bool
- property is_risk_modified¶
Gets the is_risk_modified of this FindingSummary. Determines if this risk level was modified by user.
- Returns
The is_risk_modified of this FindingSummary.
- Return type
bool
- property is_top_finding¶
Gets the is_top_finding of this FindingSummary. Indicates whether a given finding is marked as topFinding or not.
- Returns
The is_top_finding of this FindingSummary.
- Return type
bool
- property justification¶
Gets the justification of this FindingSummary. User provided reason for accepting or modifying this finding if they choose to do so.
- Returns
The justification of this FindingSummary.
- Return type
str
- property key¶
Gets the key of this FindingSummary. The unique finding key. This is a system-generated identifier. To get the finding key for a finding, use ListFindings.
- Returns
The key of this FindingSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this FindingSummary. Details about the current state of the finding.
- Returns
The lifecycle_details of this FindingSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this FindingSummary. The current state of the finding.
Allowed values for this property are: “ACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this FindingSummary.
- Return type
str
- property oneline¶
Gets the oneline of this FindingSummary. Provides a recommended approach to take to remediate the finding reported.
- Returns
The oneline of this FindingSummary.
- Return type
str
- property oracle_defined_severity¶
Gets the oracle_defined_severity of this FindingSummary. The severity of the finding as determined by security assessment. This cannot be modified by user.
- Returns
The oracle_defined_severity of this FindingSummary.
- Return type
str
- property references¶
Gets the references of this FindingSummary. Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, a STIG rule, or a GDPR Article/Recital.
- Returns
The references of this FindingSummary.
- Return type
- property remarks¶
Gets the remarks of this FindingSummary. The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation.
- Returns
The remarks of this FindingSummary.
- Return type
str
- property severity¶
Gets the severity of this FindingSummary. The severity of the finding as determined by security assessment and is same as oracleDefinedSeverity, unless modified by user.
Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, “ADVISORY”, “PASS”, “DEFERRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The severity of this FindingSummary.
- Return type
str
- property summary¶
Gets the summary of this FindingSummary. The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined.
- Returns
The summary of this FindingSummary.
- Return type
str
- property target_id¶
Gets the target_id of this FindingSummary. The OCID of the target database.
- Returns
The target_id of this FindingSummary.
- Return type
str
- property time_updated¶
Gets the time_updated of this FindingSummary. The date and time the risk level of finding was last updated, in the format defined by RFC3339.
- Returns
The time_updated of this FindingSummary.
- Return type
datetime
- property time_valid_until¶
Gets the time_valid_until of this FindingSummary. The time until which the change in severity(deferred / modified) of this finding is valid.
- Returns
The time_valid_until of this FindingSummary.
- Return type
datetime
- property title¶
Gets the title of this FindingSummary. The short title for the finding.
- Returns
The title of this FindingSummary.
- Return type
str