MonitoredResourceSummary¶

class oci.stack_monitoring.models.MonitoredResourceSummary(**kwargs)¶

Bases: object

The information about monitored resource.

Attributes

`LICENSE_ENTERPRISE_EDITION`	A constant which can be used with the license property of a MonitoredResourceSummary.
`LICENSE_STANDARD_EDITION`	A constant which can be used with the license property of a MonitoredResourceSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary.
`RESOURCE_CATEGORY_APPLICATION`	A constant which can be used with the resource_category property of a MonitoredResourceSummary.
`RESOURCE_CATEGORY_DATABASE`	A constant which can be used with the resource_category property of a MonitoredResourceSummary.
`RESOURCE_CATEGORY_MIDDLEWARE`	A constant which can be used with the resource_category property of a MonitoredResourceSummary.
`RESOURCE_CATEGORY_UNKNOWN`	A constant which can be used with the resource_category property of a MonitoredResourceSummary.
`SOURCE_TYPE_COLLECTD`	A constant which can be used with the source_type property of a MonitoredResourceSummary.
`SOURCE_TYPE_OCI_NATIVE`	A constant which can be used with the source_type property of a MonitoredResourceSummary.
`SOURCE_TYPE_PROMETHEUS`	A constant which can be used with the source_type property of a MonitoredResourceSummary.
`SOURCE_TYPE_SM_MGMT_AGENT_MONITORED`	A constant which can be used with the source_type property of a MonitoredResourceSummary.
`SOURCE_TYPE_SM_REPO_ONLY`	A constant which can be used with the source_type property of a MonitoredResourceSummary.
`SOURCE_TYPE_TELEGRAF`	A constant which can be used with the source_type property of a MonitoredResourceSummary.
`compartment_id`	Gets the compartment_id of this MonitoredResourceSummary.
`defined_tags`	Gets the defined_tags of this MonitoredResourceSummary.
`display_name`	Gets the display_name of this MonitoredResourceSummary.
`external_id`	Gets the external_id of this MonitoredResourceSummary.
`freeform_tags`	Gets the freeform_tags of this MonitoredResourceSummary.
`host_name`	Gets the host_name of this MonitoredResourceSummary.
`id`	[Required] Gets the id of this MonitoredResourceSummary.
`license`	Gets the license of this MonitoredResourceSummary.
`lifecycle_state`	Gets the lifecycle_state of this MonitoredResourceSummary.
`management_agent_id`	Gets the management_agent_id of this MonitoredResourceSummary.
`name`	[Required] Gets the name of this MonitoredResourceSummary.
`properties`	Gets the properties of this MonitoredResourceSummary.
`resource_category`	Gets the resource_category of this MonitoredResourceSummary.
`source_type`	Gets the source_type of this MonitoredResourceSummary.
`system_tags`	Gets the system_tags of this MonitoredResourceSummary.
`time_created`	Gets the time_created of this MonitoredResourceSummary.
`time_updated`	Gets the time_updated of this MonitoredResourceSummary.
`type`	[Required] Gets the type of this MonitoredResourceSummary.

Methods

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

LICENSE_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'¶: A constant which can be used with the license property of a MonitoredResourceSummary. This constant has a value of “ENTERPRISE_EDITION”

LICENSE_STANDARD_EDITION = 'STANDARD_EDITION'¶: A constant which can be used with the license property of a MonitoredResourceSummary. This constant has a value of “STANDARD_EDITION”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceSummary. This constant has a value of “UPDATING”

RESOURCE_CATEGORY_APPLICATION = 'APPLICATION'¶: A constant which can be used with the resource_category property of a MonitoredResourceSummary. This constant has a value of “APPLICATION”

RESOURCE_CATEGORY_DATABASE = 'DATABASE'¶: A constant which can be used with the resource_category property of a MonitoredResourceSummary. This constant has a value of “DATABASE”

RESOURCE_CATEGORY_MIDDLEWARE = 'MIDDLEWARE'¶: A constant which can be used with the resource_category property of a MonitoredResourceSummary. This constant has a value of “MIDDLEWARE”

RESOURCE_CATEGORY_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the resource_category property of a MonitoredResourceSummary. This constant has a value of “UNKNOWN”

SOURCE_TYPE_COLLECTD = 'COLLECTD'¶: A constant which can be used with the source_type property of a MonitoredResourceSummary. This constant has a value of “COLLECTD”

SOURCE_TYPE_OCI_NATIVE = 'OCI_NATIVE'¶: A constant which can be used with the source_type property of a MonitoredResourceSummary. This constant has a value of “OCI_NATIVE”

SOURCE_TYPE_PROMETHEUS = 'PROMETHEUS'¶: A constant which can be used with the source_type property of a MonitoredResourceSummary. This constant has a value of “PROMETHEUS”

SOURCE_TYPE_SM_MGMT_AGENT_MONITORED = 'SM_MGMT_AGENT_MONITORED'¶: A constant which can be used with the source_type property of a MonitoredResourceSummary. This constant has a value of “SM_MGMT_AGENT_MONITORED”

SOURCE_TYPE_SM_REPO_ONLY = 'SM_REPO_ONLY'¶: A constant which can be used with the source_type property of a MonitoredResourceSummary. This constant has a value of “SM_REPO_ONLY”

SOURCE_TYPE_TELEGRAF = 'TELEGRAF'¶: A constant which can be used with the source_type property of a MonitoredResourceSummary. This constant has a value of “TELEGRAF”

__init__(**kwargs)¶

Initializes a new MonitoredResourceSummary 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 MonitoredResourceSummary.
name (str) – The value to assign to the name property of this MonitoredResourceSummary.
display_name (str) – The value to assign to the display_name property of this MonitoredResourceSummary.
type (str) – The value to assign to the type property of this MonitoredResourceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this MonitoredResourceSummary.
host_name (str) – The value to assign to the host_name property of this MonitoredResourceSummary.
external_id (str) – The value to assign to the external_id property of this MonitoredResourceSummary.
management_agent_id (str) – The value to assign to the management_agent_id property of this MonitoredResourceSummary.
time_created (datetime) – The value to assign to the time_created property of this MonitoredResourceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MonitoredResourceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MonitoredResourceSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
properties (list[oci.stack_monitoring.models.MonitoredResourceProperty]) – The value to assign to the properties property of this MonitoredResourceSummary.
license (str) – The value to assign to the license property of this MonitoredResourceSummary. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
source_type (str) – The value to assign to the source_type property of this MonitoredResourceSummary. Allowed values for this property are: “SM_MGMT_AGENT_MONITORED”, “SM_REPO_ONLY”, “OCI_NATIVE”, “PROMETHEUS”, “TELEGRAF”, “COLLECTD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_category (str) – The value to assign to the resource_category property of this MonitoredResourceSummary. Allowed values for this property are: “APPLICATION”, “DATABASE”, “MIDDLEWARE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MonitoredResourceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MonitoredResourceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MonitoredResourceSummary.

compartment_id¶

Gets the compartment_id of this MonitoredResourceSummary. Compartment Identifier OCID.

Returns:	The compartment_id of this MonitoredResourceSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this MonitoredResourceSummary. 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 MonitoredResourceSummary.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this MonitoredResourceSummary. Monitored resource display name.

Returns:	The display_name of this MonitoredResourceSummary.
Return type:	str

external_id¶

Gets the external_id of this MonitoredResourceSummary. External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource.

Returns:	The external_id of this MonitoredResourceSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this MonitoredResourceSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this MonitoredResourceSummary.
Return type:	dict(str, str)

host_name¶

Gets the host_name of this MonitoredResourceSummary. Monitored Resource Host Name.

Returns:	The host_name of this MonitoredResourceSummary.
Return type:	str

id¶

[Required] Gets the id of this MonitoredResourceSummary. Monitored resource identifier OCID.

Returns:	The id of this MonitoredResourceSummary.
Return type:	str

license¶

Gets the license of this MonitoredResourceSummary. License edition of the monitored resource.

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

Returns:	The license of this MonitoredResourceSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this MonitoredResourceSummary. The current state of the monitored resource.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 MonitoredResourceSummary.
Return type:	str

management_agent_id¶

Gets the management_agent_id of this MonitoredResourceSummary. Management Agent Identifier OCID.

Returns:	The management_agent_id of this MonitoredResourceSummary.
Return type:	str

name¶

[Required] Gets the name of this MonitoredResourceSummary. Monitored Resource Name.

Returns:	The name of this MonitoredResourceSummary.
Return type:	str

properties¶

Gets the properties of this MonitoredResourceSummary. List of monitored resource properties.

Returns:	The properties of this MonitoredResourceSummary.
Return type:	list[oci.stack_monitoring.models.MonitoredResourceProperty]

resource_category¶

Gets the resource_category of this MonitoredResourceSummary. Resource Category to indicate the kind of resource type.

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

Returns:	The resource_category of this MonitoredResourceSummary.
Return type:	str

source_type¶

Gets the source_type of this MonitoredResourceSummary. Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.

Allowed values for this property are: “SM_MGMT_AGENT_MONITORED”, “SM_REPO_ONLY”, “OCI_NATIVE”, “PROMETHEUS”, “TELEGRAF”, “COLLECTD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The source_type of this MonitoredResourceSummary.
Return type:	str

system_tags¶

Gets the system_tags of this MonitoredResourceSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this MonitoredResourceSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this MonitoredResourceSummary. Monitored resource creation time. An RFC3339 formatted datetime string.

Returns:	The time_created of this MonitoredResourceSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this MonitoredResourceSummary. Monitored resource update time. An RFC3339 formatted datetime string.

Returns:	The time_updated of this MonitoredResourceSummary.
Return type:	datetime

type¶

[Required] Gets the type of this MonitoredResourceSummary. Monitored Resource Type.

Returns:	The type of this MonitoredResourceSummary.
Return type:	str