FindingAnalyticsSummary¶

class oci.data_safe.models.FindingAnalyticsSummary(**kwargs)¶

Bases: object

The summary of information about the analytics data of findings or top findings. It includes details such as metric name, findinKey, title (topFindingCategory for top finding), severity (topFindingStatus for top finding) and targetId.

Attributes

`METRIC_NAME_FINDING_STATS`	A constant which can be used with the metric_name property of a FindingAnalyticsSummary.
`METRIC_NAME_TOP_FINDING_STATS`	A constant which can be used with the metric_name property of a FindingAnalyticsSummary.
`count`	[Required] Gets the count of this FindingAnalyticsSummary.
`dimensions`	Gets the dimensions of this FindingAnalyticsSummary.
`metric_name`	[Required] Gets the metric_name of this FindingAnalyticsSummary.

Methods

__init__(**kwargs) Initializes a new FindingAnalyticsSummary object with values from keyword arguments.

METRIC_NAME_FINDING_STATS = 'FINDING_STATS'¶: A constant which can be used with the metric_name property of a FindingAnalyticsSummary. This constant has a value of “FINDING_STATS”

METRIC_NAME_TOP_FINDING_STATS = 'TOP_FINDING_STATS'¶: A constant which can be used with the metric_name property of a FindingAnalyticsSummary. This constant has a value of “TOP_FINDING_STATS”

__init__(**kwargs)¶

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

Parameters:

metric_name (str) – The value to assign to the metric_name property of this FindingAnalyticsSummary. Allowed values for this property are: “TOP_FINDING_STATS”, “FINDING_STATS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dimensions (oci.data_safe.models.FindingAnalyticsDimensions) – The value to assign to the dimensions property of this FindingAnalyticsSummary.
count (int) – The value to assign to the count property of this FindingAnalyticsSummary.

count¶

[Required] Gets the count of this FindingAnalyticsSummary. The total count for the aggregation metric.

Returns:	The count of this FindingAnalyticsSummary.
Return type:	int

dimensions¶

Gets the dimensions of this FindingAnalyticsSummary.

Returns:	The dimensions of this FindingAnalyticsSummary.
Return type:	oci.data_safe.models.FindingAnalyticsDimensions

metric_name¶

[Required] Gets the metric_name of this FindingAnalyticsSummary. The name of the aggregation metric.

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

Returns:	The metric_name of this FindingAnalyticsSummary.
Return type:	str