MetricExtension

class oci.stack_monitoring.models.MetricExtension(**kwargs)

Bases: object

Detailed information of the Metric Extension resource

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_DELETED

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

STATUS_DRAFT

A constant which can be used with the status property of a MetricExtension.

STATUS_PUBLISHED

A constant which can be used with the status property of a MetricExtension.

collection_method

[Required] Gets the collection_method of this MetricExtension.

collection_recurrences

[Required] Gets the collection_recurrences of this MetricExtension.

compartment_id

[Required] Gets the compartment_id of this MetricExtension.

created_by

Gets the created_by of this MetricExtension.

description

Gets the description of this MetricExtension.

display_name

[Required] Gets the display_name of this MetricExtension.

enabled_on_resources

Gets the enabled_on_resources of this MetricExtension.

enabled_on_resources_count

Gets the enabled_on_resources_count of this MetricExtension.

id

[Required] Gets the id of this MetricExtension.

last_updated_by

Gets the last_updated_by of this MetricExtension.

lifecycle_state

Gets the lifecycle_state of this MetricExtension.

metric_list

[Required] Gets the metric_list of this MetricExtension.

name

[Required] Gets the name of this MetricExtension.

query_properties

[Required] Gets the query_properties of this MetricExtension.

resource_type

[Required] Gets the resource_type of this MetricExtension.

resource_uri

Gets the resource_uri of this MetricExtension.

status

[Required] Gets the status of this MetricExtension.

tenant_id

[Required] Gets the tenant_id of this MetricExtension.

time_created

Gets the time_created of this MetricExtension.

time_updated

Gets the time_updated of this MetricExtension.

Methods:

__init__(**kwargs)

Initializes a new MetricExtension object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

STATUS_DRAFT = 'DRAFT'

A constant which can be used with the status property of a MetricExtension. This constant has a value of “DRAFT”

STATUS_PUBLISHED = 'PUBLISHED'

A constant which can be used with the status property of a MetricExtension. This constant has a value of “PUBLISHED”

__init__(**kwargs)

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

  • name (str) – The value to assign to the name property of this MetricExtension.

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

  • description (str) – The value to assign to the description property of this MetricExtension.

  • resource_type (str) – The value to assign to the resource_type property of this MetricExtension.

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

  • tenant_id (str) – The value to assign to the tenant_id property of this MetricExtension.

  • collection_method (str) – The value to assign to the collection_method property of this MetricExtension.

  • status (str) – The value to assign to the status property of this MetricExtension. 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 MetricExtension. 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’.

  • created_by (str) – The value to assign to the created_by property of this MetricExtension.

  • last_updated_by (str) – The value to assign to the last_updated_by property of this MetricExtension.

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

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

  • collection_recurrences (str) – The value to assign to the collection_recurrences property of this MetricExtension.

  • metric_list (list[oci.stack_monitoring.models.Metric]) – The value to assign to the metric_list property of this MetricExtension.

  • query_properties (oci.stack_monitoring.models.MetricExtensionQueryProperties) – The value to assign to the query_properties property of this MetricExtension.

  • enabled_on_resources (list[oci.stack_monitoring.models.EnabledResourceDetails]) – The value to assign to the enabled_on_resources property of this MetricExtension.

  • enabled_on_resources_count (int) – The value to assign to the enabled_on_resources_count property of this MetricExtension.

  • resource_uri (str) – The value to assign to the resource_uri property of this MetricExtension.

property collection_method

[Required] Gets the collection_method of this MetricExtension. Collection Method Metric Extension applies

Returns

The collection_method of this MetricExtension.

Return type

str

property collection_recurrences

[Required] Gets the collection_recurrences of this MetricExtension. Schedule of metric extension should use RFC 5545 format -> recur-rule-part = “FREQ”;”INTERVAL” where FREQ rule part identifies the type of recurrence rule. Valid values are “MINUTELY”,”HOURLY”,”DAILY” to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1

Returns

The collection_recurrences of this MetricExtension.

Return type

str

property compartment_id

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

Returns

The compartment_id of this MetricExtension.

Return type

str

property created_by

Gets the created_by of this MetricExtension. Created by user

Returns

The created_by of this MetricExtension.

Return type

str

property description

Gets the description of this MetricExtension. Description of the metric extension.

Returns

The description of this MetricExtension.

Return type

str

property display_name

[Required] Gets the display_name of this MetricExtension. Metric Extension resource display name

Returns

The display_name of this MetricExtension.

Return type

str

property enabled_on_resources

Gets the enabled_on_resources of this MetricExtension. List of resource details objects having resourceIds on which this metric extension is enabled.

Returns

The enabled_on_resources of this MetricExtension.

Return type

list[oci.stack_monitoring.models.EnabledResourceDetails]

property enabled_on_resources_count

Gets the enabled_on_resources_count of this MetricExtension. Count of resources on which this metric extension is enabled.

Returns

The enabled_on_resources_count of this MetricExtension.

Return type

int

property id

[Required] Gets the id of this MetricExtension. The OCID of Metric Extension resource

Returns

The id of this MetricExtension.

Return type

str

property last_updated_by

Gets the last_updated_by of this MetricExtension. Last updated by user

Returns

The last_updated_by of this MetricExtension.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this MetricExtension. 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 MetricExtension.

Return type

str

property metric_list

[Required] Gets the metric_list of this MetricExtension. List of metrics which are part of this metric extension

Returns

The metric_list of this MetricExtension.

Return type

list[oci.stack_monitoring.models.Metric]

property name

[Required] Gets the name of this MetricExtension. Metric Extension resource name

Returns

The name of this MetricExtension.

Return type

str

property query_properties

[Required] Gets the query_properties of this MetricExtension.

Returns

The query_properties of this MetricExtension.

Return type

oci.stack_monitoring.models.MetricExtensionQueryProperties

property resource_type

[Required] Gets the resource_type of this MetricExtension. Resource type to which Metric Extension applies

Returns

The resource_type of this MetricExtension.

Return type

str

property resource_uri

Gets the resource_uri of this MetricExtension. The URI path that the user can do a GET on to access the metric extension metadata

Returns

The resource_uri of this MetricExtension.

Return type

str

property status

[Required] Gets the status of this MetricExtension. The current status of the metric extension i.e. whether it is Draft or Published

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 MetricExtension.

Return type

str

property tenant_id

[Required] Gets the tenant_id of this MetricExtension. Tenant Identifier OCID

Returns

The tenant_id of this MetricExtension.

Return type

str

property time_created

Gets the time_created of this MetricExtension. Metric Extension creation time. An RFC3339 formatted datetime string.

Returns

The time_created of this MetricExtension.

Return type

datetime

property time_updated

Gets the time_updated of this MetricExtension. Metric Extension update time. An RFC3339 formatted datetime string.

Returns

The time_updated of this MetricExtension.

Return type

datetime