CreatePrometheusEmitterDataSourceDetails¶
- class oci.management_agent.models.CreatePrometheusEmitterDataSourceDetails(**kwargs)¶
Bases:
CreateDataSourceDetailsA Prometheus emitter data source.
Attributes:
A constant which can be used with the type property of a CreateDataSourceDetails.
A constant which can be used with the type property of a CreateDataSourceDetails.
Gets the allow_metrics of this CreatePrometheusEmitterDataSourceDetails.
[Required] Gets the compartment_id of this CreateDataSourceDetails.
Gets the connection_timeout of this CreatePrometheusEmitterDataSourceDetails.
Gets the metric_dimensions of this CreatePrometheusEmitterDataSourceDetails.
[Required] Gets the name of this CreateDataSourceDetails.
[Required] Gets the namespace of this CreatePrometheusEmitterDataSourceDetails.
Gets the proxy_url of this CreatePrometheusEmitterDataSourceDetails.
Gets the read_data_limit_in_kilobytes of this CreatePrometheusEmitterDataSourceDetails.
Gets the read_timeout of this CreatePrometheusEmitterDataSourceDetails.
Gets the resource_group of this CreatePrometheusEmitterDataSourceDetails.
Gets the schedule_mins of this CreatePrometheusEmitterDataSourceDetails.
[Required] Gets the type of this CreateDataSourceDetails.
[Required] Gets the url of this CreatePrometheusEmitterDataSourceDetails.
Methods:
__init__(**kwargs)Initializes a new CreatePrometheusEmitterDataSourceDetails 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.
- TYPE_KUBERNETES_CLUSTER = 'KUBERNETES_CLUSTER'¶
A constant which can be used with the type property of a CreateDataSourceDetails. This constant has a value of “KUBERNETES_CLUSTER”
- TYPE_PROMETHEUS_EMITTER = 'PROMETHEUS_EMITTER'¶
A constant which can be used with the type property of a CreateDataSourceDetails. This constant has a value of “PROMETHEUS_EMITTER”
- __init__(**kwargs)¶
Initializes a new CreatePrometheusEmitterDataSourceDetails object with values from keyword arguments. The default value of the
typeattribute of this class isPROMETHEUS_EMITTERand 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 CreatePrometheusEmitterDataSourceDetails. Allowed values for this property are: “KUBERNETES_CLUSTER”, “PROMETHEUS_EMITTER”
name (str) – The value to assign to the name property of this CreatePrometheusEmitterDataSourceDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreatePrometheusEmitterDataSourceDetails.
url (str) – The value to assign to the url property of this CreatePrometheusEmitterDataSourceDetails.
namespace (str) – The value to assign to the namespace property of this CreatePrometheusEmitterDataSourceDetails.
allow_metrics (str) – The value to assign to the allow_metrics property of this CreatePrometheusEmitterDataSourceDetails.
proxy_url (str) – The value to assign to the proxy_url property of this CreatePrometheusEmitterDataSourceDetails.
connection_timeout (int) – The value to assign to the connection_timeout property of this CreatePrometheusEmitterDataSourceDetails.
read_timeout (int) – The value to assign to the read_timeout property of this CreatePrometheusEmitterDataSourceDetails.
read_data_limit_in_kilobytes (int) – The value to assign to the read_data_limit_in_kilobytes property of this CreatePrometheusEmitterDataSourceDetails.
schedule_mins (int) – The value to assign to the schedule_mins property of this CreatePrometheusEmitterDataSourceDetails.
resource_group (str) – The value to assign to the resource_group property of this CreatePrometheusEmitterDataSourceDetails.
metric_dimensions (list[oci.management_agent.models.MetricDimension]) – The value to assign to the metric_dimensions property of this CreatePrometheusEmitterDataSourceDetails.
- property allow_metrics¶
Gets the allow_metrics of this CreatePrometheusEmitterDataSourceDetails. Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
- Returns
The allow_metrics of this CreatePrometheusEmitterDataSourceDetails.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this CreateDataSourceDetails. Compartment owning this DataSource.
- Returns
The compartment_id of this CreateDataSourceDetails.
- Return type
str
- property connection_timeout¶
Gets the connection_timeout of this CreatePrometheusEmitterDataSourceDetails. Number in milliseconds. The timeout for connecting to the Prometheus Exporter’s endpoint.
- Returns
The connection_timeout of this CreatePrometheusEmitterDataSourceDetails.
- Return type
int
- 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 metric_dimensions¶
Gets the metric_dimensions of this CreatePrometheusEmitterDataSourceDetails. The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
- Returns
The metric_dimensions of this CreatePrometheusEmitterDataSourceDetails.
- Return type
- property name¶
[Required] Gets the name of this CreateDataSourceDetails. Unique name of the DataSource.
- Returns
The name of this CreateDataSourceDetails.
- Return type
str
- property namespace¶
[Required] Gets the namespace of this CreatePrometheusEmitterDataSourceDetails. The OCI monitoring namespace to which scraped metrics should be uploaded.
- Returns
The namespace of this CreatePrometheusEmitterDataSourceDetails.
- Return type
str
- property proxy_url¶
Gets the proxy_url of this CreatePrometheusEmitterDataSourceDetails. The url of the network proxy that provides access to the Prometheus Exporter’s endpoint (url required property).
- Returns
The proxy_url of this CreatePrometheusEmitterDataSourceDetails.
- Return type
str
- property read_data_limit_in_kilobytes¶
Gets the read_data_limit_in_kilobytes of this CreatePrometheusEmitterDataSourceDetails. Number in kilobytes. The limit on the data being sent, not to exceed the agent’s fixed limit of 400 (KB).
- Returns
The read_data_limit_in_kilobytes of this CreatePrometheusEmitterDataSourceDetails.
- Return type
int
- property read_timeout¶
Gets the read_timeout of this CreatePrometheusEmitterDataSourceDetails. Number in milliseconds. The timeout for reading the response from the Prometheus Exporter’s endpoint.
- Returns
The read_timeout of this CreatePrometheusEmitterDataSourceDetails.
- Return type
int
- property resource_group¶
Gets the resource_group of this CreatePrometheusEmitterDataSourceDetails. OCI monitoring resource group to assign the metric to.
- Returns
The resource_group of this CreatePrometheusEmitterDataSourceDetails.
- Return type
str
- property schedule_mins¶
Gets the schedule_mins of this CreatePrometheusEmitterDataSourceDetails. Number in minutes. The scraping occurs at the specified interval.
- Returns
The schedule_mins of this CreatePrometheusEmitterDataSourceDetails.
- Return type
int
- property type¶
[Required] Gets the type of this CreateDataSourceDetails. The type of the DataSource.
Allowed values for this property are: “KUBERNETES_CLUSTER”, “PROMETHEUS_EMITTER”
- Returns
The type of this CreateDataSourceDetails.
- Return type
str
- property url¶
[Required] Gets the url of this CreatePrometheusEmitterDataSourceDetails. The url through which the Prometheus Exporter publishes its metrics. (http only)
- Returns
The url of this CreatePrometheusEmitterDataSourceDetails.
- Return type
str