MonitoredResourceType¶

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

Bases: object

The response object for create monitored resource type and get monitored resource type operations.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a MonitoredResourceType.
`RESOURCE_CATEGORY_APPLICATION`	A constant which can be used with the resource_category property of a MonitoredResourceType.
`RESOURCE_CATEGORY_DATABASE`	A constant which can be used with the resource_category property of a MonitoredResourceType.
`RESOURCE_CATEGORY_INFRASTRUCTURE`	A constant which can be used with the resource_category property of a MonitoredResourceType.
`RESOURCE_CATEGORY_MIDDLEWARE`	A constant which can be used with the resource_category property of a MonitoredResourceType.
`RESOURCE_CATEGORY_UNKNOWN`	A constant which can be used with the resource_category property of a MonitoredResourceType.
`SOURCE_TYPE_COLLECTD`	A constant which can be used with the source_type property of a MonitoredResourceType.
`SOURCE_TYPE_OCI_NATIVE`	A constant which can be used with the source_type property of a MonitoredResourceType.
`SOURCE_TYPE_PROMETHEUS`	A constant which can be used with the source_type property of a MonitoredResourceType.
`SOURCE_TYPE_SM_MGMT_AGENT_MONITORED`	A constant which can be used with the source_type property of a MonitoredResourceType.
`SOURCE_TYPE_SM_REPO_ONLY`	A constant which can be used with the source_type property of a MonitoredResourceType.
`SOURCE_TYPE_TELEGRAF`	A constant which can be used with the source_type property of a MonitoredResourceType.
`additional_namespace_map`	Gets the additional_namespace_map of this MonitoredResourceType.
`availability_metrics_config`	Gets the availability_metrics_config of this MonitoredResourceType.
`compartment_id`	[Required] Gets the compartment_id of this MonitoredResourceType.
`defined_tags`	Gets the defined_tags of this MonitoredResourceType.
`description`	Gets the description of this MonitoredResourceType.
`display_name`	Gets the display_name of this MonitoredResourceType.
`freeform_tags`	Gets the freeform_tags of this MonitoredResourceType.
`handler_config`	Gets the handler_config of this MonitoredResourceType.
`id`	[Required] Gets the id of this MonitoredResourceType.
`is_system_defined`	Gets the is_system_defined of this MonitoredResourceType.
`lifecycle_state`	Gets the lifecycle_state of this MonitoredResourceType.
`metadata`	Gets the metadata of this MonitoredResourceType.
`metric_namespace`	Gets the metric_namespace of this MonitoredResourceType.
`name`	[Required] Gets the name of this MonitoredResourceType.
`resource_category`	Gets the resource_category of this MonitoredResourceType.
`source_type`	Gets the source_type of this MonitoredResourceType.
`system_tags`	Gets the system_tags of this MonitoredResourceType.
`tenancy_id`	Gets the tenancy_id of this MonitoredResourceType.
`time_created`	Gets the time_created of this MonitoredResourceType.
`time_updated`	Gets the time_updated of this MonitoredResourceType.

Methods:

__init__(**kwargs)

Initializes a new MonitoredResourceType object with values from keyword arguments.

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a MonitoredResourceType. This constant has a value of “INACTIVE”

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

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

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

RESOURCE_CATEGORY_INFRASTRUCTURE = 'INFRASTRUCTURE'¶: A constant which can be used with the resource_category property of a MonitoredResourceType. This constant has a value of “INFRASTRUCTURE”

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

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

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

__init__(**kwargs)¶

Initializes a new MonitoredResourceType 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 MonitoredResourceType.
name (str) – The value to assign to the name property of this MonitoredResourceType.
display_name (str) – The value to assign to the display_name property of this MonitoredResourceType.
description (str) – The value to assign to the description property of this MonitoredResourceType.
metric_namespace (str) – The value to assign to the metric_namespace property of this MonitoredResourceType.
compartment_id (str) – The value to assign to the compartment_id property of this MonitoredResourceType.
tenancy_id (str) – The value to assign to the tenancy_id property of this MonitoredResourceType.
availability_metrics_config (oci.stack_monitoring.models.AvailabilityMetricsDetails) – The value to assign to the availability_metrics_config property of this MonitoredResourceType.
handler_config (oci.stack_monitoring.models.AgentExtensionHandlerConfiguration) – The value to assign to the handler_config property of this MonitoredResourceType.
is_system_defined (bool) – The value to assign to the is_system_defined property of this MonitoredResourceType.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MonitoredResourceType. 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’.
source_type (str) – The value to assign to the source_type property of this MonitoredResourceType. 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 MonitoredResourceType. Allowed values for this property are: “APPLICATION”, “DATABASE”, “MIDDLEWARE”, “INFRASTRUCTURE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this MonitoredResourceType.
time_updated (datetime) – The value to assign to the time_updated property of this MonitoredResourceType.
additional_namespace_map (dict(str, str)) – The value to assign to the additional_namespace_map property of this MonitoredResourceType.
metadata (oci.stack_monitoring.models.ResourceTypeMetadataDetails) – The value to assign to the metadata property of this MonitoredResourceType.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MonitoredResourceType.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MonitoredResourceType.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MonitoredResourceType.

property additional_namespace_map¶

Gets the additional_namespace_map of this MonitoredResourceType. Key/Value pair for additional namespaces used by stack monitoring services for SYSTEM (SMB) resource types.

Returns: The additional_namespace_map of this MonitoredResourceType.
Return type: dict(str, str)

property availability_metrics_config¶

Gets the availability_metrics_config of this MonitoredResourceType.

Returns: The availability_metrics_config of this MonitoredResourceType.
Return type: oci.stack_monitoring.models.AvailabilityMetricsDetails

property compartment_id¶

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

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

property defined_tags¶

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

property description¶

Gets the description of this MonitoredResourceType. A friendly description.

Returns: The description of this MonitoredResourceType.
Return type: str

property display_name¶

Gets the display_name of this MonitoredResourceType. Monitored resource type display name.

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

property freeform_tags¶

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

property handler_config¶

Gets the handler_config of this MonitoredResourceType.

Returns: The handler_config of this MonitoredResourceType.
Return type: oci.stack_monitoring.models.AgentExtensionHandlerConfiguration

property id¶

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

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

property is_system_defined¶

Gets the is_system_defined of this MonitoredResourceType. If boolean flag is true, then the resource type cannot be modified or deleted.

Returns: The is_system_defined of this MonitoredResourceType.
Return type: bool

property lifecycle_state¶

Gets the lifecycle_state of this MonitoredResourceType. Lifecycle state of the monitored resource type.

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 MonitoredResourceType.
Return type: str

property metadata¶

Gets the metadata of this MonitoredResourceType.

Returns: The metadata of this MonitoredResourceType.
Return type: oci.stack_monitoring.models.ResourceTypeMetadataDetails

property metric_namespace¶

Gets the metric_namespace of this MonitoredResourceType. Metric namespace for resource type.

Returns: The metric_namespace of this MonitoredResourceType.
Return type: str

property name¶

[Required] Gets the name of this MonitoredResourceType. A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed.

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

property resource_category¶

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

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

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

property source_type¶

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

property system_tags¶

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

property tenancy_id¶

Gets the tenancy_id of this MonitoredResourceType. Tenancy Identifier OCID.

Returns: The tenancy_id of this MonitoredResourceType.
Return type: str

property time_created¶

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

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

property time_updated¶

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

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