MetricExtensionSummary¶
- class oci.stack_monitoring.models.MetricExtensionSummary(**kwargs)¶
Bases:
objectSummary information about metric extension resources
Attributes:
A constant which can be used with the collection_method property of a MetricExtensionSummary.
A constant which can be used with the collection_method property of a MetricExtensionSummary.
A constant which can be used with the collection_method property of a MetricExtensionSummary.
A constant which can be used with the collection_method property of a MetricExtensionSummary.
A constant which can be used with the lifecycle_state property of a MetricExtensionSummary.
A constant which can be used with the lifecycle_state property of a MetricExtensionSummary.
A constant which can be used with the status property of a MetricExtensionSummary.
A constant which can be used with the status property of a MetricExtensionSummary.
Gets the collection_method of this MetricExtensionSummary.
[Required] Gets the compartment_id of this MetricExtensionSummary.
Gets the description of this MetricExtensionSummary.
Gets the display_name of this MetricExtensionSummary.
Gets the enabled_on_resources_count of this MetricExtensionSummary.
[Required] Gets the id of this MetricExtensionSummary.
Gets the lifecycle_state of this MetricExtensionSummary.
[Required] Gets the name of this MetricExtensionSummary.
[Required] Gets the resource_type of this MetricExtensionSummary.
Gets the resource_uri of this MetricExtensionSummary.
[Required] Gets the status of this MetricExtensionSummary.
Gets the time_created of this MetricExtensionSummary.
Gets the time_updated of this MetricExtensionSummary.
Methods:
__init__(**kwargs)Initializes a new MetricExtensionSummary object with values from keyword arguments.
- COLLECTION_METHOD_HTTP = 'HTTP'¶
A constant which can be used with the collection_method property of a MetricExtensionSummary. This constant has a value of “HTTP”
- COLLECTION_METHOD_JMX = 'JMX'¶
A constant which can be used with the collection_method property of a MetricExtensionSummary. This constant has a value of “JMX”
- COLLECTION_METHOD_OS_COMMAND = 'OS_COMMAND'¶
A constant which can be used with the collection_method property of a MetricExtensionSummary. This constant has a value of “OS_COMMAND”
- COLLECTION_METHOD_SQL = 'SQL'¶
A constant which can be used with the collection_method property of a MetricExtensionSummary. This constant has a value of “SQL”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a MetricExtensionSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a MetricExtensionSummary. This constant has a value of “DELETED”
- STATUS_DRAFT = 'DRAFT'¶
A constant which can be used with the status property of a MetricExtensionSummary. This constant has a value of “DRAFT”
- STATUS_PUBLISHED = 'PUBLISHED'¶
A constant which can be used with the status property of a MetricExtensionSummary. This constant has a value of “PUBLISHED”
- __init__(**kwargs)¶
Initializes a new MetricExtensionSummary 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 MetricExtensionSummary.
name (str) – The value to assign to the name property of this MetricExtensionSummary.
display_name (str) – The value to assign to the display_name property of this MetricExtensionSummary.
description (str) – The value to assign to the description property of this MetricExtensionSummary.
resource_type (str) – The value to assign to the resource_type property of this MetricExtensionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this MetricExtensionSummary.
status (str) – The value to assign to the status property of this MetricExtensionSummary. Allowed values for this property are: “DRAFT”, “PUBLISHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MetricExtensionSummary. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘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 MetricExtensionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MetricExtensionSummary.
collection_method (str) – The value to assign to the collection_method property of this MetricExtensionSummary. Allowed values for this property are: “OS_COMMAND”, “SQL”, “JMX”, “HTTP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
enabled_on_resources_count (int) – The value to assign to the enabled_on_resources_count property of this MetricExtensionSummary.
resource_uri (str) – The value to assign to the resource_uri property of this MetricExtensionSummary.
- property collection_method¶
Gets the collection_method of this MetricExtensionSummary. Type of possible collection methods.
Allowed values for this property are: “OS_COMMAND”, “SQL”, “JMX”, “HTTP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The collection_method of this MetricExtensionSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this MetricExtensionSummary. Compartment Identifier OCID
- Returns
The compartment_id of this MetricExtensionSummary.
- Return type
str
- property description¶
Gets the description of this MetricExtensionSummary. Description of the metric extension.
- Returns
The description of this MetricExtensionSummary.
- Return type
str
- property display_name¶
Gets the display_name of this MetricExtensionSummary. Metric Extension resource display name.
- Returns
The display_name of this MetricExtensionSummary.
- Return type
str
- property enabled_on_resources_count¶
Gets the enabled_on_resources_count of this MetricExtensionSummary. Count of resources on which this metric extension is enabled.
- Returns
The enabled_on_resources_count of this MetricExtensionSummary.
- Return type
int
- property id¶
[Required] Gets the id of this MetricExtensionSummary. The OCID of metric extension.
- Returns
The id of this MetricExtensionSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this MetricExtensionSummary. The current lifecycle state of the metric extension
Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this MetricExtensionSummary.
- Return type
str
- property name¶
[Required] Gets the name of this MetricExtensionSummary. Metric Extension Resource name.
- Returns
The name of this MetricExtensionSummary.
- Return type
str
- property resource_type¶
[Required] Gets the resource_type of this MetricExtensionSummary. Resource type to which Metric Extension applies
- Returns
The resource_type of this MetricExtensionSummary.
- Return type
str
- property resource_uri¶
Gets the resource_uri of this MetricExtensionSummary. The URI path that the user can do a GET on to access the metric extension metadata
- Returns
The resource_uri of this MetricExtensionSummary.
- Return type
str
- property status¶
[Required] Gets the status of this MetricExtensionSummary. The current state of the metric extension.
Allowed values for this property are: “DRAFT”, “PUBLISHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this MetricExtensionSummary.
- Return type
str
- property time_created¶
Gets the time_created of this MetricExtensionSummary. Metric Extension creation time. An RFC3339 formatted datetime string
- Returns
The time_created of this MetricExtensionSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this MetricExtensionSummary. Metric Extension updation time. An RFC3339 formatted datetime string
- Returns
The time_updated of this MetricExtensionSummary.
- Return type
datetime