Class JobDefinition

Representation of a job definition resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

Inheritance

object

JobDefinition

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 JobDefinition

Properties

CatalogId

Declaration

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

Property Value

Type	Description
string	The data catalog's OCID.

ConnectionKey

Declaration

[JsonProperty(PropertyName = "connectionKey")]
public string ConnectionKey { get; set; }

Property Value

Type	Description
string	The key of the default connection resource to be used for harvest, sampling, profiling jobs. This may be overridden in each job instance.

CreatedById

Declaration

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

Property Value

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

DataAssetKey

Declaration

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

Property Value

Type	Description
string	The key of the data asset for which the job is defined.

Description

Declaration

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

Property Value

Type	Description
string	Detailed description of the job definition.

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.

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.

InternalVersion

Declaration

[JsonProperty(PropertyName = "internalVersion")]
public string InternalVersion { get; set; }

Property Value

Type	Description
string	Version of the job definition object. Used internally but can be visible to users.

IsIncremental

Declaration

[JsonProperty(PropertyName = "isIncremental")]
public bool? IsIncremental { get; set; }

Property Value

Type	Description
bool?	Specifies if the job definition is incremental or full.

IsSampleDataExtracted

Declaration

[JsonProperty(PropertyName = "isSampleDataExtracted")]
public bool? IsSampleDataExtracted { get; set; }

Property Value

Type	Description
bool?	Specify if sample data to be extracted as part of this harvest.

JobExecutionState

Declaration

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

Property Value

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

JobType

Declaration

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

Property Value

Type	Description
JobType?	Type of the job definition.

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 definition resource that is immutable.

Remarks

Required

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	Lifecycle state of the job definition.

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 properties which are specific to the job type. Each job type definition 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 definitions have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

SampleDataSizeInMBs

Declaration

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

Property Value

Type	Description
int?	Specify the sample data size in MB, specified as number of rows, for this metadata harvest.

ScheduleType

Declaration

[JsonProperty(PropertyName = "scheduleType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public JobScheduleType? ScheduleType { get; set; }

Property Value

Type	Description
JobScheduleType?	Type of job schedule for the latest job executed.

TimeCreated

Declaration

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

Property Value

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

TimeLatestExecutionEnded

Declaration

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

Property Value

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

TimeLatestExecutionStarted

Declaration

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

Property Value

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

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The last time that any change was made to the data asset. 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 definition.

Uri

Declaration

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

Property Value

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