JobMetric¶
- class oci.data_catalog.models.JobMetric(**kwargs)¶
Bases:
objectA set of metrics are collected periodically to assess the state and performance characteristics of the execution instance of a job. The metrics are grouped based on their category and sub categories and aggregated based on their batch information.
Methods:
__init__(**kwargs)Initializes a new JobMetric object with values from keyword arguments.
Attributes:
Gets the batch_key of this JobMetric.
Gets the category of this JobMetric.
Gets the created_by_id of this JobMetric.
Gets the description of this JobMetric.
Gets the display_name of this JobMetric.
Gets the job_execution_key of this JobMetric.
[Required] Gets the key of this JobMetric.
Gets the sub_category of this JobMetric.
Gets the time_created of this JobMetric.
Gets the time_inserted of this JobMetric.
Gets the time_updated of this JobMetric.
Gets the unit of this JobMetric.
Gets the updated_by_id of this JobMetric.
Gets the uri of this JobMetric.
Gets the value of this JobMetric.
- __init__(**kwargs)¶
Initializes a new JobMetric object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
key (str) – The value to assign to the key property of this JobMetric.
description (str) – The value to assign to the description property of this JobMetric.
job_execution_key (str) – The value to assign to the job_execution_key property of this JobMetric.
time_inserted (datetime) – The value to assign to the time_inserted property of this JobMetric.
category (str) – The value to assign to the category property of this JobMetric.
display_name (str) – The value to assign to the display_name property of this JobMetric.
sub_category (str) – The value to assign to the sub_category property of this JobMetric.
unit (str) – The value to assign to the unit property of this JobMetric.
value (str) – The value to assign to the value property of this JobMetric.
batch_key (str) – The value to assign to the batch_key property of this JobMetric.
uri (str) – The value to assign to the uri property of this JobMetric.
time_created (datetime) – The value to assign to the time_created property of this JobMetric.
time_updated (datetime) – The value to assign to the time_updated property of this JobMetric.
created_by_id (str) – The value to assign to the created_by_id property of this JobMetric.
updated_by_id (str) – The value to assign to the updated_by_id property of this JobMetric.
- property batch_key¶
Gets the batch_key of this JobMetric. Batch key for grouping, may be null.
- Returns
The batch_key of this JobMetric.
- Return type
str
- property category¶
Gets the category of this JobMetric. Category of this metric.
- Returns
The category of this JobMetric.
- Return type
str
- property created_by_id¶
Gets the created_by_id of this JobMetric. OCID of the user who created the metric for this job. Usually the executor of the job instance.
- Returns
The created_by_id of this JobMetric.
- Return type
str
- property description¶
Gets the description of this JobMetric. Detailed description of the metric.
- Returns
The description of this JobMetric.
- Return type
str
- property display_name¶
Gets the display_name of this JobMetric. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this JobMetric.
- Return type
str
- property job_execution_key¶
Gets the job_execution_key of this JobMetric. The unique key of the parent job execution for which the job metric resource is being created.
- Returns
The job_execution_key of this JobMetric.
- Return type
str
- property key¶
[Required] Gets the key of this JobMetric. Key of the job metric that is immutable.
- Returns
The key of this JobMetric.
- Return type
str
- property sub_category¶
Gets the sub_category of this JobMetric. Sub category of this metric under the category. Used for aggregating values. May be null.
- Returns
The sub_category of this JobMetric.
- Return type
str
- property time_created¶
Gets the time_created of this JobMetric. The date and time the job metric was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
- Returns
The time_created of this JobMetric.
- Return type
datetime
- property time_inserted¶
Gets the time_inserted of this JobMetric. The time the metric was logged or captured in the system where the job executed. An RFC3339 formatted datetime string.
- Returns
The time_inserted of this JobMetric.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this JobMetric. The last time that this metric was updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this JobMetric.
- Return type
datetime
- property unit¶
Gets the unit of this JobMetric. Unit of this metric.
- Returns
The unit of this JobMetric.
- Return type
str
- property updated_by_id¶
Gets the updated_by_id of this JobMetric. OCID of the user who created the metric for this job. Usually the executor of the job instance.
- Returns
The updated_by_id of this JobMetric.
- Return type
str
- property uri¶
Gets the uri of this JobMetric. URI to the job metric instance in the API.
- Returns
The uri of this JobMetric.
- Return type
str
- property value¶
Gets the value of this JobMetric. Value of this metric.
- Returns
The value of this JobMetric.
- Return type
str