Show / Hide Table of Contents

Class JobMetric

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

Inheritance
object
JobMetric
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatacatalogService.Models
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class JobMetric

Properties

BatchKey

Declaration
[JsonProperty(PropertyName = "batchKey")]
public string BatchKey { get; set; }
Property Value
Type Description
string

Batch key for grouping, may be null.

Category

Declaration
[JsonProperty(PropertyName = "category")]
public string Category { get; set; }
Property Value
Type Description
string

Category of this metric.

CreatedById

Declaration
[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }
Property Value
Type Description
string

OCID of the user who created the metric for this job. Usually the executor of the job instance.

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Detailed description of the metric.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

JobExecutionKey

Declaration
[JsonProperty(PropertyName = "jobExecutionKey")]
public string JobExecutionKey { get; set; }
Property Value
Type Description
string

The unique key of the parent job execution for which the job metric resource is being created.

Key

Declaration
[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type Description
string

Key of the job metric that is immutable.

Remarks

Required

SubCategory

Declaration
[JsonProperty(PropertyName = "subCategory")]
public string SubCategory { get; set; }
Property Value
Type Description
string

Sub category of this metric under the category. Used for aggregating values. May be null.

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the job metric was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeInserted

Declaration
[JsonProperty(PropertyName = "timeInserted")]
public DateTime? TimeInserted { get; set; }
Property Value
Type Description
DateTime?

The time the metric was logged or captured in the system where the job executed. An RFC3339 formatted datetime string.

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The last time that this metric was updated. An RFC3339 formatted datetime string.

Unit

Declaration
[JsonProperty(PropertyName = "unit")]
public string Unit { get; set; }
Property Value
Type Description
string

Unit of this metric.

UpdatedById

Declaration
[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }
Property Value
Type Description
string

OCID of the user who created the metric for this job. Usually the executor of the job instance.

Uri

Declaration
[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }
Property Value
Type Description
string

URI to the job metric instance in the API.

Value

Declaration
[JsonProperty(PropertyName = "value")]
public string Value { get; set; }
Property Value
Type Description
string

Value of this metric.

In this article
Back to top