ResourceSummary

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

Bases: object

Summary of CG Resource

Attributes:

RISK_LEVEL_CRITICAL

A constant which can be used with the risk_level property of a ResourceSummary.

RISK_LEVEL_HIGH

A constant which can be used with the risk_level property of a ResourceSummary.

RISK_LEVEL_LOW

A constant which can be used with the risk_level property of a ResourceSummary.

RISK_LEVEL_MEDIUM

A constant which can be used with the risk_level property of a ResourceSummary.

RISK_LEVEL_MINOR

A constant which can be used with the risk_level property of a ResourceSummary.

RISK_LEVEL_NONE

A constant which can be used with the risk_level property of a ResourceSummary.

compartment_id

[Required] Gets the compartment_id of this ResourceSummary.

defined_tags

Gets the defined_tags of this ResourceSummary.

freeform_tags

Gets the freeform_tags of this ResourceSummary.

id

[Required] Gets the id of this ResourceSummary.

open_ports_count

Gets the open_ports_count of this ResourceSummary.

problem_count

Gets the problem_count of this ResourceSummary.

region

Gets the region of this ResourceSummary.

resource_name

Gets the resource_name of this ResourceSummary.

resource_type

Gets the resource_type of this ResourceSummary.

risk_level

Gets the risk_level of this ResourceSummary.

system_tags

Gets the system_tags of this ResourceSummary.

target_id

Gets the target_id of this ResourceSummary.

target_name

Gets the target_name of this ResourceSummary.

vulnerability_count

Gets the vulnerability_count of this ResourceSummary.

Methods:

__init__(**kwargs)

Initializes a new ResourceSummary object with values from keyword arguments.

RISK_LEVEL_CRITICAL = 'CRITICAL'

A constant which can be used with the risk_level property of a ResourceSummary. This constant has a value of “CRITICAL”

RISK_LEVEL_HIGH = 'HIGH'

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

RISK_LEVEL_LOW = 'LOW'

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

RISK_LEVEL_MEDIUM = 'MEDIUM'

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

RISK_LEVEL_MINOR = 'MINOR'

A constant which can be used with the risk_level property of a ResourceSummary. This constant has a value of “MINOR”

RISK_LEVEL_NONE = 'NONE'

A constant which can be used with the risk_level property of a ResourceSummary. This constant has a value of “NONE”

__init__(**kwargs)

Initializes a new ResourceSummary 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 ResourceSummary.

  • resource_name (str) – The value to assign to the resource_name property of this ResourceSummary.

  • resource_type (str) – The value to assign to the resource_type property of this ResourceSummary.

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

  • target_id (str) – The value to assign to the target_id property of this ResourceSummary.

  • target_name (str) – The value to assign to the target_name property of this ResourceSummary.

  • region (str) – The value to assign to the region property of this ResourceSummary.

  • risk_level (str) – The value to assign to the risk_level property of this ResourceSummary. Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “MINOR”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • problem_count (int) – The value to assign to the problem_count property of this ResourceSummary.

  • vulnerability_count (int) – The value to assign to the vulnerability_count property of this ResourceSummary.

  • open_ports_count (int) – The value to assign to the open_ports_count property of this ResourceSummary.

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

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

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

property compartment_id

[Required] Gets the compartment_id of this ResourceSummary. CompartmentId of CG Resource

Returns

The compartment_id of this ResourceSummary.

Return type

str

property defined_tags

Gets the defined_tags of this ResourceSummary. 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 ResourceSummary.

Return type

dict(str, dict(str, object))

property freeform_tags

Gets the freeform_tags of this ResourceSummary. 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 ResourceSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this ResourceSummary. Ocid for CG resource

Returns

The id of this ResourceSummary.

Return type

str

property open_ports_count

Gets the open_ports_count of this ResourceSummary. Number of open ports in a resource

Returns

The open_ports_count of this ResourceSummary.

Return type

int

property problem_count

Gets the problem_count of this ResourceSummary. Count of existing problems for a resource

Returns

The problem_count of this ResourceSummary.

Return type

int

property region

Gets the region of this ResourceSummary. region of CG Resource

Returns

The region of this ResourceSummary.

Return type

str

property resource_name

Gets the resource_name of this ResourceSummary. name of the CG resource

Returns

The resource_name of this ResourceSummary.

Return type

str

property resource_type

Gets the resource_type of this ResourceSummary. resource type of the CG resource

Returns

The resource_type of this ResourceSummary.

Return type

str

property risk_level

Gets the risk_level of this ResourceSummary. The Risk Level

Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “MINOR”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The risk_level of this ResourceSummary.

Return type

str

property system_tags

Gets the system_tags of this ResourceSummary. 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 ResourceSummary.

Return type

dict(str, dict(str, object))

property target_id

Gets the target_id of this ResourceSummary. TargetId of CG Resource

Returns

The target_id of this ResourceSummary.

Return type

str

property target_name

Gets the target_name of this ResourceSummary. Target name for the CG Resource

Returns

The target_name of this ResourceSummary.

Return type

str

property vulnerability_count

Gets the vulnerability_count of this ResourceSummary. Count of existing number of vulnerabilities in the resource

Returns

The vulnerability_count of this ResourceSummary.

Return type

int