Class JobSummary

Details of a job. Jobs are scheduled instances of a job definition.

Inheritance

object

JobSummary

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 JobSummary

Properties

CatalogId

Declaration

[JsonProperty(PropertyName = "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	The data catalog's OCID.

CreatedById

Declaration

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

Property Value

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

DataAssetKey

Declaration

[JsonProperty(PropertyName = "dataAssetKey")]
public string DataAssetKey { get; set; }

Property Value

Type	Description
string	Unique key of the data asset to which this job applies, if the job involves a data asset.

Description

Declaration

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

Property Value

Type	Description
string	Detailed description of the job.

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.

ErrorCode

Declaration

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

Property Value

Type	Description
string	Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.

ErrorMessage

Declaration

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

Property Value

Type	Description
string	Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.

ExecutionCount

Declaration

[JsonProperty(PropertyName = "executionCount")]
public int? ExecutionCount { get; set; }

Property Value

Type	Description
int?	The total number of executions for this job schedule.

Executions

Declaration

[JsonProperty(PropertyName = "executions")]
public List<JobExecutionSummary> Executions { get; set; }

Property Value

Type	Description
List<JobExecutionSummary>	Array of the executions summary associated with this job.

GlossaryKey

Declaration

[JsonProperty(PropertyName = "glossaryKey")]
public string GlossaryKey { get; set; }

Property Value

Type	Description
string	Unique key of the glossary to which this job applies.

JobDefinitionKey

Declaration

[JsonProperty(PropertyName = "jobDefinitionKey")]
public string JobDefinitionKey { get; set; }

Property Value

Type	Description
string	The unique key of the job definition resource that defined the scope of this job.

JobDefinitionName

Declaration

[JsonProperty(PropertyName = "jobDefinitionName")]
public string JobDefinitionName { get; set; }

Property Value

Type	Description
string	The display name of the job definition resource that defined the scope of this job.

JobType

Declaration

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

Property Value

Type	Description
JobType?	Type of the job.

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.

Remarks

Required

LifecycleState

Declaration

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

Property Value

Type	Description
JobLifecycleState?	Lifecycle state of the job, such as running, paused, or completed.

ScheduleCronExpression

Declaration

[JsonProperty(PropertyName = "scheduleCronExpression")]
public string ScheduleCronExpression { get; set; }

Property Value

Type	Description
string	Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

ScheduleType

Declaration

[JsonProperty(PropertyName = "scheduleType")]
public string ScheduleType { get; set; }

Property Value

Type	Description
string	Type of job schedule that is inferred from the scheduling properties.

TimeCreated

Declaration

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

Property Value

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

TimeOfLatestExecution

Declaration

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

Property Value

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

TimeScheduleBegin

Declaration

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

Property Value

Type	Description
DateTime?	Date that the schedule should be operational. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	Time that this job was last updated. An RFC3339 formatted datetime string.

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

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

Uri

Declaration

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

Property Value

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