Class JobExecution

A job execution is a unit of work being executed on behalf of a job.

Inheritance

object

JobExecution

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 JobExecution

Properties

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created the job execution.

DataEntityKey

Declaration

[JsonProperty(PropertyName = "dataEntityKey")]
public string DataEntityKey { get; set; }

Property Value

Type	Description
string	The key of the associated data entity resource.

ErrorCode

Declaration

[JsonProperty(PropertyName = "errorCode")]
public string ErrorCode { get; set; }

Property Value

Type	Description
string	Error code returned from the job execution or null if job is still running or didn't return an error.

ErrorMessage

Declaration

[JsonProperty(PropertyName = "errorMessage")]
public string ErrorMessage { get; set; }

Property Value

Type	Description
string	Error message returned from the job execution or null if job is still running or didn't return an error.

EventKey

Declaration

[JsonProperty(PropertyName = "eventKey")]
public string EventKey { get; set; }

Property Value

Type	Description
string	An identifier used for log message correlation.

ExternalUrl

Declaration

[JsonProperty(PropertyName = "externalUrl")]
public string ExternalUrl { get; set; }

Property Value

Type	Description
string	If the job is an external process, then a URL of the job for accessing this resource and its status.

JobKey

Declaration

[JsonProperty(PropertyName = "jobKey")]
public string JobKey { get; set; }

Property Value

Type	Description
string	The unique key of the parent job.

JobType

Declaration

[JsonProperty(PropertyName = "jobType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public JobType? JobType { get; set; }

Property Value

Type	Description
JobType?	Type of the job execution.

Key

Declaration

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

Property Value

Type	Description
string	Unique key of the job execution resource.

Remarks

Required

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public JobExecutionState? LifecycleState { get; set; }

Property Value

Type	Description
JobExecutionState?	Status of the job execution, such as running, paused, or completed.

ParentKey

Declaration

[JsonProperty(PropertyName = "parentKey")]
public string ParentKey { get; set; }

Property Value

Type	Description
string	The unique key of the parent execution or null if this job execution has no parent.

ProcessKey

Declaration

[JsonProperty(PropertyName = "processKey")]
public string ProcessKey { get; set; }

Property Value

Type	Description
string	Process identifier related to the job execution if the job is an external job.

Properties

Declaration

[JsonProperty(PropertyName = "properties")]
public Dictionary<string, Dictionary<string, string>> Properties { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, string>>	A map of maps that contains the execution context properties which are specific to a job execution. Each job execution may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job executions have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

Type

Description

Dictionary<string, Dictionary<string, string>>

A map of maps that contains the execution context properties which are specific to a job execution. Each job execution may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job executions have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

ScheduleInstanceKey

Declaration

[JsonProperty(PropertyName = "scheduleInstanceKey")]
public string ScheduleInstanceKey { get; set; }

Property Value

Type	Description
string	The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.

SubType

Declaration

[JsonProperty(PropertyName = "subType")]
public string SubType { get; set; }

Property Value

Type	Description
string	Sub-type of this job execution.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

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

TimeEnded

Declaration

[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }

Property Value

Type	Description
DateTime?	Time that the job execution ended or null if it hasn't yet completed. An RFC3339 formatted datetime string.

TimeStarted

Declaration

[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }

Property Value

Type	Description
DateTime?	Time that job execution started. An RFC3339 formatted datetime string.

UpdatedBy

Declaration

[JsonProperty(PropertyName = "updatedBy")]
public string UpdatedBy { get; set; }

Property Value

Type	Description
string	OCID of the user who updated the job execution.

Uri

Declaration

[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }

Property Value

Type	Description
string	URI to the job execution instance in the API.