Show / Hide Table of Contents

Class CreateJobDefinitionDetails

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
CreateJobDefinitionDetails
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 CreateJobDefinitionDetails

Properties

ConnectionKey

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

The key of the connection resource to be used for the job.

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
[Required(ErrorMessage = "DisplayName is required.")]
[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.

Remarks

Required

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.

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.

JobType

Declaration
[Required(ErrorMessage = "JobType is required.")]
[JsonProperty(PropertyName = "jobType")]
[JsonConverter(typeof(StringEnumConverter))]
public JobType? JobType { get; set; }
Property Value
Type Description
JobType?

Type of the job definition.

Remarks

Required

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.

In this article
Back to top