TargetSummary

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

Bases: object

Summary information for a target.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a TargetSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a TargetSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a TargetSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a TargetSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a TargetSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a TargetSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a TargetSummary.

TARGET_RESOURCE_TYPE_COMPARTMENT

A constant which can be used with the target_resource_type property of a TargetSummary.

TARGET_RESOURCE_TYPE_ERPCLOUD

A constant which can be used with the target_resource_type property of a TargetSummary.

TARGET_RESOURCE_TYPE_HCMCLOUD

A constant which can be used with the target_resource_type property of a TargetSummary.

TARGET_RESOURCE_TYPE_SECURITY_ZONE

A constant which can be used with the target_resource_type property of a TargetSummary.

compartment_id

[Required] Gets the compartment_id of this TargetSummary.

defined_tags

Gets the defined_tags of this TargetSummary.

display_name

Gets the display_name of this TargetSummary.

freeform_tags

Gets the freeform_tags of this TargetSummary.

id

[Required] Gets the id of this TargetSummary.

lifecycle_state

Gets the lifecycle_state of this TargetSummary.

lifecyle_details

Gets the lifecyle_details of this TargetSummary.

recipe_count

[Required] Gets the recipe_count of this TargetSummary.

system_tags

Gets the system_tags of this TargetSummary.

target_resource_id

[Required] Gets the target_resource_id of this TargetSummary.

target_resource_type

[Required] Gets the target_resource_type of this TargetSummary.

time_created

Gets the time_created of this TargetSummary.

time_updated

Gets the time_updated of this TargetSummary.

Methods:

__init__(**kwargs)

Initializes a new TargetSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a TargetSummary. This constant has a value of “UPDATING”

TARGET_RESOURCE_TYPE_COMPARTMENT = 'COMPARTMENT'

A constant which can be used with the target_resource_type property of a TargetSummary. This constant has a value of “COMPARTMENT”

TARGET_RESOURCE_TYPE_ERPCLOUD = 'ERPCLOUD'

A constant which can be used with the target_resource_type property of a TargetSummary. This constant has a value of “ERPCLOUD”

TARGET_RESOURCE_TYPE_HCMCLOUD = 'HCMCLOUD'

A constant which can be used with the target_resource_type property of a TargetSummary. This constant has a value of “HCMCLOUD”

TARGET_RESOURCE_TYPE_SECURITY_ZONE = 'SECURITY_ZONE'

A constant which can be used with the target_resource_type property of a TargetSummary. This constant has a value of “SECURITY_ZONE”

__init__(**kwargs)

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

  • display_name (str) – The value to assign to the display_name property of this TargetSummary.

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

  • target_resource_type (str) – The value to assign to the target_resource_type property of this TargetSummary. Allowed values for this property are: “COMPARTMENT”, “ERPCLOUD”, “HCMCLOUD”, “SECURITY_ZONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • target_resource_id (str) – The value to assign to the target_resource_id property of this TargetSummary.

  • recipe_count (int) – The value to assign to the recipe_count property of this TargetSummary.

  • time_created (datetime) – The value to assign to the time_created property of this TargetSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this TargetSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this TargetSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecyle_details (str) – The value to assign to the lifecyle_details property of this TargetSummary.

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

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

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

property compartment_id

[Required] Gets the compartment_id of this TargetSummary. Compartment OCID where the resource is created

Returns

The compartment_id of this TargetSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this TargetSummary. Target display name

Returns

The display_name of this TargetSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this TargetSummary. Unique identifier for target that can’t be changed after creation

Returns

The id of this TargetSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this TargetSummary. The current lifecycle state of the resource

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this TargetSummary.

Return type

str

property lifecyle_details

Gets the lifecyle_details of this TargetSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]

Returns

The lifecyle_details of this TargetSummary.

Return type

str

property recipe_count

[Required] Gets the recipe_count of this TargetSummary. Total number of recipes attached to target

Returns

The recipe_count of this TargetSummary.

Return type

int

property system_tags

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

Return type

dict(str, dict(str, object))

property target_resource_id

[Required] Gets the target_resource_id of this TargetSummary. Resource ID which the target uses to monitor

Returns

The target_resource_id of this TargetSummary.

Return type

str

property target_resource_type

[Required] Gets the target_resource_type of this TargetSummary. Type of resource that’s associated with the target(compartment/HCMCloud/ERPCloud)

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

Returns

The target_resource_type of this TargetSummary.

Return type

str

property time_created

Gets the time_created of this TargetSummary. The date and time the target was created. Format defined by RFC3339.

Returns

The time_created of this TargetSummary.

Return type

datetime

property time_updated

Gets the time_updated of this TargetSummary. The date and time the target was last updated. Format defined by RFC3339.

Returns

The time_updated of this TargetSummary.

Return type

datetime