MonitoredResource¶

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

Bases: object

The response object for create monitored resource and get monitored resource operations. This contains information about the monitored resource. Credentials and credential aliases attributes will be returned as null due to security reasons.

Attributes

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

Methods

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

LICENSE_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'¶: A constant which can be used with the license property of a MonitoredResource. 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 MonitoredResource. 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 MonitoredResource. This constant has a value of “ACTIVE”

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

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

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

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

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

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

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

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

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

SOURCE_TYPE_COLLECTD = 'COLLECTD'¶: A constant which can be used with the source_type property of a MonitoredResource. 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 MonitoredResource. 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 MonitoredResource. 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 MonitoredResource. 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 MonitoredResource. 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 MonitoredResource. This constant has a value of “TELEGRAF”

__init__(**kwargs)¶

Initializes a new MonitoredResource 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 MonitoredResource.
name (str) – The value to assign to the name property of this MonitoredResource.
display_name (str) – The value to assign to the display_name property of this MonitoredResource.
type (str) – The value to assign to the type property of this MonitoredResource.
compartment_id (str) – The value to assign to the compartment_id property of this MonitoredResource.
tenant_id (str) – The value to assign to the tenant_id property of this MonitoredResource.
host_name (str) – The value to assign to the host_name property of this MonitoredResource.
external_id (str) – The value to assign to the external_id property of this MonitoredResource.
management_agent_id (str) – The value to assign to the management_agent_id property of this MonitoredResource.
resource_time_zone (str) – The value to assign to the resource_time_zone property of this MonitoredResource.
time_created (datetime) – The value to assign to the time_created property of this MonitoredResource.
time_updated (datetime) – The value to assign to the time_updated property of this MonitoredResource.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MonitoredResource. 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’.
license (str) – The value to assign to the license property of this MonitoredResource. 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 MonitoredResource. 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 MonitoredResource. 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’.
properties (list[oci.stack_monitoring.models.MonitoredResourceProperty]) – The value to assign to the properties property of this MonitoredResource.
database_connection_details (oci.stack_monitoring.models.ConnectionDetails) – The value to assign to the database_connection_details property of this MonitoredResource.
credentials (oci.stack_monitoring.models.MonitoredResourceCredential) – The value to assign to the credentials property of this MonitoredResource.
aliases (oci.stack_monitoring.models.MonitoredResourceAliasCredential) – The value to assign to the aliases property of this MonitoredResource.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MonitoredResource.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MonitoredResource.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MonitoredResource.

aliases¶

Gets the aliases of this MonitoredResource.

Returns:	The aliases of this MonitoredResource.
Return type:	oci.stack_monitoring.models.MonitoredResourceAliasCredential

compartment_id¶

[Required] Gets the compartment_id of this MonitoredResource. Compartment Identifier OCID.

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

credentials¶

Gets the credentials of this MonitoredResource.

Returns:	The credentials of this MonitoredResource.
Return type:	oci.stack_monitoring.models.MonitoredResourceCredential

database_connection_details¶

Gets the database_connection_details of this MonitoredResource.

Returns:	The database_connection_details of this MonitoredResource.
Return type:	oci.stack_monitoring.models.ConnectionDetails

defined_tags¶

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

display_name¶

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

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

external_id¶

Gets the external_id of this MonitoredResource. The external resource identifier OCID. External resource is any OCI resource which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

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

freeform_tags¶

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

host_name¶

Gets the host_name of this MonitoredResource. Monitored resource host name.

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

id¶

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

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

license¶

Gets the license of this MonitoredResource. 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 MonitoredResource.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this MonitoredResource. Lifecycle 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 MonitoredResource.
Return type:	str

management_agent_id¶

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

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

name¶

[Required] Gets the name of this MonitoredResource. Monitored resource name.

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

properties¶

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

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

resource_category¶

Gets the resource_category of this MonitoredResource. 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 MonitoredResource.
Return type:	str

resource_time_zone¶

Gets the resource_time_zone of this MonitoredResource. Time zone in the form of tz database canonical zone ID.

Returns:	The resource_time_zone of this MonitoredResource.
Return type:	str

source_type¶

Gets the source_type of this MonitoredResource. 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 MonitoredResource.
Return type:	str

system_tags¶

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

tenant_id¶

[Required] Gets the tenant_id of this MonitoredResource. Tenancy Identifier OCID.

Returns:	The tenant_id of this MonitoredResource.
Return type:	str

time_created¶

Gets the time_created of this MonitoredResource. The date and time when the monitored resource was created, expressed in RFC 3339 timestamp format.

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

time_updated¶

Gets the time_updated of this MonitoredResource. The date and time when the monitored resource was last updated, expressed in RFC 3339 timestamp format.

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

type¶

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

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