Class JobDefinitionSummary

A list of job definition resources. 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

JobDefinitionSummary

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 JobDefinitionSummary

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 connection resource used in harvest, sampling, profiling jobs.

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 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, if the job involves a glossary.

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.

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.

Uri

Declaration

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

Property Value

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