ImportOciTelemetryResourcesTaskDetails¶

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

Bases: MonitoredResourceTaskDetails

Request details for importing resources from Telemetry like resources from OCI Native Services and prometheus.

Attributes:

`SOURCE_OCI_TELEMETRY_COLLECTD`	A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails.
`SOURCE_OCI_TELEMETRY_NATIVE`	A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails.
`SOURCE_OCI_TELEMETRY_PROMETHEUS`	A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails.
`SOURCE_OCI_TELEMETRY_TELEGRAF`	A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails.
`TYPE_IMPORT_OCI_TELEMETRY_RESOURCES`	A constant which can be used with the type property of a MonitoredResourceTaskDetails.
`TYPE_UPDATE_AGENT_RECEIVER`	A constant which can be used with the type property of a MonitoredResourceTaskDetails.
`TYPE_UPDATE_RESOURCE_TYPE_CONFIGS`	A constant which can be used with the type property of a MonitoredResourceTaskDetails.
`availability_proxy_metric_collection_interval`	Gets the availability_proxy_metric_collection_interval of this ImportOciTelemetryResourcesTaskDetails.
`availability_proxy_metrics`	Gets the availability_proxy_metrics of this ImportOciTelemetryResourcesTaskDetails.
`console_path_prefix`	Gets the console_path_prefix of this ImportOciTelemetryResourcesTaskDetails.
`external_id_mapping`	Gets the external_id_mapping of this ImportOciTelemetryResourcesTaskDetails.
`lifecycle_status_mappings_for_up_status`	Gets the lifecycle_status_mappings_for_up_status of this ImportOciTelemetryResourcesTaskDetails.
`namespace`	[Required] Gets the namespace of this ImportOciTelemetryResourcesTaskDetails.
`resource_group`	Gets the resource_group of this ImportOciTelemetryResourcesTaskDetails.
`resource_name_filter`	Gets the resource_name_filter of this ImportOciTelemetryResourcesTaskDetails.
`resource_name_mapping`	Gets the resource_name_mapping of this ImportOciTelemetryResourcesTaskDetails.
`resource_type_filter`	Gets the resource_type_filter of this ImportOciTelemetryResourcesTaskDetails.
`resource_type_mapping`	Gets the resource_type_mapping of this ImportOciTelemetryResourcesTaskDetails.
`service_base_url`	Gets the service_base_url of this ImportOciTelemetryResourcesTaskDetails.
`should_use_metrics_flow_for_status`	Gets the should_use_metrics_flow_for_status of this ImportOciTelemetryResourcesTaskDetails.
`source`	[Required] Gets the source of this ImportOciTelemetryResourcesTaskDetails. Source from where the metrics pushed to telemetry. Possible values: * OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from OCI Native Services. * OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus. * OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver. * OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
`type`	[Required] Gets the type of this MonitoredResourceTaskDetails.

Methods:

`__init__`(**kwargs)	Initializes a new ImportOciTelemetryResourcesTaskDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

SOURCE_OCI_TELEMETRY_COLLECTD = 'OCI_TELEMETRY_COLLECTD'¶: A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails. This constant has a value of “OCI_TELEMETRY_COLLECTD”

SOURCE_OCI_TELEMETRY_NATIVE = 'OCI_TELEMETRY_NATIVE'¶: A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails. This constant has a value of “OCI_TELEMETRY_NATIVE”

SOURCE_OCI_TELEMETRY_PROMETHEUS = 'OCI_TELEMETRY_PROMETHEUS'¶: A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails. This constant has a value of “OCI_TELEMETRY_PROMETHEUS”

SOURCE_OCI_TELEMETRY_TELEGRAF = 'OCI_TELEMETRY_TELEGRAF'¶: A constant which can be used with the source property of a ImportOciTelemetryResourcesTaskDetails. This constant has a value of “OCI_TELEMETRY_TELEGRAF”

TYPE_IMPORT_OCI_TELEMETRY_RESOURCES = 'IMPORT_OCI_TELEMETRY_RESOURCES'¶: A constant which can be used with the type property of a MonitoredResourceTaskDetails. This constant has a value of “IMPORT_OCI_TELEMETRY_RESOURCES”

TYPE_UPDATE_AGENT_RECEIVER = 'UPDATE_AGENT_RECEIVER'¶: A constant which can be used with the type property of a MonitoredResourceTaskDetails. This constant has a value of “UPDATE_AGENT_RECEIVER”

TYPE_UPDATE_RESOURCE_TYPE_CONFIGS = 'UPDATE_RESOURCE_TYPE_CONFIGS'¶: A constant which can be used with the type property of a MonitoredResourceTaskDetails. This constant has a value of “UPDATE_RESOURCE_TYPE_CONFIGS”

__init__(**kwargs)¶

Initializes a new ImportOciTelemetryResourcesTaskDetails object with values from keyword arguments. The default value of the type attribute of this class is IMPORT_OCI_TELEMETRY_RESOURCES and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

type (str) – The value to assign to the type property of this ImportOciTelemetryResourcesTaskDetails. Allowed values for this property are: “IMPORT_OCI_TELEMETRY_RESOURCES”, “UPDATE_AGENT_RECEIVER”, “UPDATE_RESOURCE_TYPE_CONFIGS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
source (str) – The value to assign to the source property of this ImportOciTelemetryResourcesTaskDetails. Allowed values for this property are: “OCI_TELEMETRY_NATIVE”, “OCI_TELEMETRY_PROMETHEUS”, “OCI_TELEMETRY_TELEGRAF”, “OCI_TELEMETRY_COLLECTD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
namespace (str) – The value to assign to the namespace property of this ImportOciTelemetryResourcesTaskDetails.
resource_group (str) – The value to assign to the resource_group property of this ImportOciTelemetryResourcesTaskDetails.
should_use_metrics_flow_for_status (bool) – The value to assign to the should_use_metrics_flow_for_status property of this ImportOciTelemetryResourcesTaskDetails.
service_base_url (str) – The value to assign to the service_base_url property of this ImportOciTelemetryResourcesTaskDetails.
console_path_prefix (str) – The value to assign to the console_path_prefix property of this ImportOciTelemetryResourcesTaskDetails.
lifecycle_status_mappings_for_up_status (list[str]) – The value to assign to the lifecycle_status_mappings_for_up_status property of this ImportOciTelemetryResourcesTaskDetails.
resource_name_mapping (str) – The value to assign to the resource_name_mapping property of this ImportOciTelemetryResourcesTaskDetails.
external_id_mapping (str) – The value to assign to the external_id_mapping property of this ImportOciTelemetryResourcesTaskDetails.
resource_type_mapping (str) – The value to assign to the resource_type_mapping property of this ImportOciTelemetryResourcesTaskDetails.
resource_name_filter (str) – The value to assign to the resource_name_filter property of this ImportOciTelemetryResourcesTaskDetails.
resource_type_filter (str) – The value to assign to the resource_type_filter property of this ImportOciTelemetryResourcesTaskDetails.
availability_proxy_metrics (list[str]) – The value to assign to the availability_proxy_metrics property of this ImportOciTelemetryResourcesTaskDetails.
availability_proxy_metric_collection_interval (int) – The value to assign to the availability_proxy_metric_collection_interval property of this ImportOciTelemetryResourcesTaskDetails.

property availability_proxy_metric_collection_interval¶

Gets the availability_proxy_metric_collection_interval of this ImportOciTelemetryResourcesTaskDetails. Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property ‘availabilityProxyMetrics’.

Returns: The availability_proxy_metric_collection_interval of this ImportOciTelemetryResourcesTaskDetails.
Return type: int

property availability_proxy_metrics¶

Gets the availability_proxy_metrics of this ImportOciTelemetryResourcesTaskDetails. List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property ‘availabilityProxyMetricCollectionInterval’. If no metrics are specified, availability will not be calculated for the resource.

Returns: The availability_proxy_metrics of this ImportOciTelemetryResourcesTaskDetails.
Return type: list[str]

property console_path_prefix¶

Gets the console_path_prefix of this ImportOciTelemetryResourcesTaskDetails. The console path prefix to use for providing service home url page navigation. For example if the prefix provided is ‘security/bastion/bastions’, the URL used for navigation will be https://<cloudhostname>/security/bastion/bastions/<resourceOcid>. If not provided, service home page link will not be shown in the stack monitoring home page.

Returns: The console_path_prefix of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property external_id_mapping¶

Gets the external_id_mapping of this ImportOciTelemetryResourcesTaskDetails. The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.

Returns: The external_id_mapping of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property lifecycle_status_mappings_for_up_status¶

Gets the lifecycle_status_mappings_for_up_status of this ImportOciTelemetryResourcesTaskDetails. Lifecycle states of the external resource which reflects the status of the resource being up.

Returns: The lifecycle_status_mappings_for_up_status of this ImportOciTelemetryResourcesTaskDetails.
Return type: list[str]

property namespace¶

[Required] Gets the namespace of this ImportOciTelemetryResourcesTaskDetails. Name space to be used for OCI Native service resources discovery.

Returns: The namespace of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property resource_group¶

Gets the resource_group of this ImportOciTelemetryResourcesTaskDetails. The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.

Returns: The resource_group of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property resource_name_filter¶

Gets the resource_name_filter of this ImportOciTelemetryResourcesTaskDetails. The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.

Returns: The resource_name_filter of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property resource_name_mapping¶

Gets the resource_name_mapping of this ImportOciTelemetryResourcesTaskDetails. The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.

Returns: The resource_name_mapping of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property resource_type_filter¶

Gets the resource_type_filter of this ImportOciTelemetryResourcesTaskDetails. The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.

Returns: The resource_type_filter of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property resource_type_mapping¶

Gets the resource_type_mapping of this ImportOciTelemetryResourcesTaskDetails. The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.

Returns: The resource_type_mapping of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property service_base_url¶

Gets the service_base_url of this ImportOciTelemetryResourcesTaskDetails. The base URL of the OCI service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.

Returns: The service_base_url of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property should_use_metrics_flow_for_status¶

Gets the should_use_metrics_flow_for_status of this ImportOciTelemetryResourcesTaskDetails. Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in OCI service.

Returns: The should_use_metrics_flow_for_status of this ImportOciTelemetryResourcesTaskDetails.
Return type: bool

property source¶

[Required] Gets the source of this ImportOciTelemetryResourcesTaskDetails. Source from where the metrics pushed to telemetry. Possible values:

OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from OCI Native Services.

OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.

OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.

OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.

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

Returns: The source of this ImportOciTelemetryResourcesTaskDetails.
Return type: str

property type¶

[Required] Gets the type of this MonitoredResourceTaskDetails. Task type.

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

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