CheckSummary

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

Bases: object

The summary of the security rule to be evaluated by security assessment to create finding.

Attributes:

SUGGESTED_SEVERITY_ADVISORY

A constant which can be used with the suggested_severity property of a CheckSummary.

SUGGESTED_SEVERITY_DEFERRED

A constant which can be used with the suggested_severity property of a CheckSummary.

SUGGESTED_SEVERITY_EVALUATE

A constant which can be used with the suggested_severity property of a CheckSummary.

SUGGESTED_SEVERITY_HIGH

A constant which can be used with the suggested_severity property of a CheckSummary.

SUGGESTED_SEVERITY_LOW

A constant which can be used with the suggested_severity property of a CheckSummary.

SUGGESTED_SEVERITY_MEDIUM

A constant which can be used with the suggested_severity property of a CheckSummary.

SUGGESTED_SEVERITY_PASS

A constant which can be used with the suggested_severity property of a CheckSummary.

category

Gets the category of this CheckSummary.

key

[Required] Gets the key of this CheckSummary.

oneline

Gets the oneline of this CheckSummary.

references

Gets the references of this CheckSummary.

remarks

Gets the remarks of this CheckSummary.

suggested_severity

Gets the suggested_severity of this CheckSummary.

title

[Required] Gets the title of this CheckSummary.

Methods:

__init__(**kwargs)

Initializes a new CheckSummary object with values from keyword arguments.

SUGGESTED_SEVERITY_ADVISORY = 'ADVISORY'

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

SUGGESTED_SEVERITY_DEFERRED = 'DEFERRED'

A constant which can be used with the suggested_severity property of a CheckSummary. This constant has a value of “DEFERRED”

SUGGESTED_SEVERITY_EVALUATE = 'EVALUATE'

A constant which can be used with the suggested_severity property of a CheckSummary. This constant has a value of “EVALUATE”

SUGGESTED_SEVERITY_HIGH = 'HIGH'

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

SUGGESTED_SEVERITY_LOW = 'LOW'

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

SUGGESTED_SEVERITY_MEDIUM = 'MEDIUM'

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

SUGGESTED_SEVERITY_PASS = 'PASS'

A constant which can be used with the suggested_severity property of a CheckSummary. This constant has a value of “PASS”

__init__(**kwargs)

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

Parameters
  • key (str) – The value to assign to the key property of this CheckSummary.

  • title (str) – The value to assign to the title property of this CheckSummary.

  • remarks (str) – The value to assign to the remarks property of this CheckSummary.

  • references (oci.data_safe.models.References) – The value to assign to the references property of this CheckSummary.

  • category (str) – The value to assign to the category property of this CheckSummary.

  • oneline (str) – The value to assign to the oneline property of this CheckSummary.

  • suggested_severity (str) – The value to assign to the suggested_severity property of this CheckSummary. 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’.

property category

Gets the category of this CheckSummary. The category to which the check belongs to.

Returns

The category of this CheckSummary.

Return type

str

property key

[Required] Gets the key of this CheckSummary. A unique identifier for the check.

Returns

The key of this CheckSummary.

Return type

str

property oneline

Gets the oneline of this CheckSummary. Provides a recommended approach to take to remediate the check reported.

Returns

The oneline of this CheckSummary.

Return type

str

property references

Gets the references of this CheckSummary. Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Recommended Practice.

Returns

The references of this CheckSummary.

Return type

oci.data_safe.models.References

property remarks

Gets the remarks of this CheckSummary. The explanation of the issue in this check. 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 CheckSummary.

Return type

str

property suggested_severity

Gets the suggested_severity of this CheckSummary. The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment.

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 suggested_severity of this CheckSummary.

Return type

str

property title

[Required] Gets the title of this CheckSummary. The short title for the check.

Returns

The title of this CheckSummary.

Return type

str