FindingSummary

class oci.data_safe.models.FindingSummary(**kwargs)

Bases: object

The particular finding reported by the security assessment.

Attributes

SEVERITY_ADVISORY A constant which can be used with the severity property of a FindingSummary.
SEVERITY_EVALUATE A constant which can be used with the severity property of a FindingSummary.
SEVERITY_HIGH A constant which can be used with the severity property of a FindingSummary.
SEVERITY_LOW A constant which can be used with the severity property of a FindingSummary.
SEVERITY_MEDIUM A constant which can be used with the severity property of a FindingSummary.
SEVERITY_PASS A constant which can be used with the severity property of a FindingSummary.
assessment_id Gets the assessment_id of this FindingSummary.
details Gets the details of this FindingSummary.
key Gets the key of this FindingSummary.
references Gets the references of this FindingSummary.
remarks Gets the remarks of this FindingSummary.
severity Gets the severity of this FindingSummary.
summary Gets the summary of this FindingSummary.
target_id Gets the target_id of this FindingSummary.
title Gets the title of this FindingSummary.

Methods

__init__(**kwargs) Initializes a new FindingSummary object with values from keyword arguments.
SEVERITY_ADVISORY = 'ADVISORY'

A constant which can be used with the severity property of a FindingSummary. This constant has a value of “ADVISORY”

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”, ‘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.
  • title (str) – The value to assign to the title 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.
  • references (oci.data_safe.models.References) – The value to assign to the references property of this FindingSummary.
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
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
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
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:oci.data_safe.models.References
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
severity

Gets the severity of this FindingSummary. The severity of the finding.

Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, “ADVISORY”, “PASS”, ‘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
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
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
title

Gets the title of this FindingSummary. The short title for the finding.

Returns:The title of this FindingSummary.
Return type:str