Class EnrichmentJob

Object representing to EnrichmentJob. ocidEntityType: generativeaisemanticstorejob adLocality: regional

Inheritance

object

EnrichmentJob

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaidataService.Models

Assembly: OCI.DotNetSDK.Generativeaidata.dll

Syntax

public class EnrichmentJob

Properties

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration

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

Property Value

Type	Description
string	An optional description of the EnrichmentJob.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.

EnrichmentJobConfiguration

Declaration

[Required(ErrorMessage = "EnrichmentJobConfiguration is required.")]
[JsonProperty(PropertyName = "enrichmentJobConfiguration")]
public EnrichmentJobConfiguration EnrichmentJobConfiguration { get; set; }

Property Value

Type	Description
EnrichmentJobConfiguration

Remarks

Required

EnrichmentJobType

Declaration

[Required(ErrorMessage = "EnrichmentJobType is required.")]
[JsonProperty(PropertyName = "enrichmentJobType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public EnrichmentJobType? EnrichmentJobType { get; set; }

Property Value

Type	Description
EnrichmentJobType?	Enrichment job type. Supported values are Full Build (all supported objects in a given schema), Partial Build (selected tables and/or supported objects in a given schema), and Delta Refresh (objects in a given schema that have changed since the previous enrichment job).

Remarks

Required

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the Semantic Store job.

Remarks

Required

LifecycleDetails

Declaration

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

Property Value

Type	Description
string	A message describing the current state in more detail that can provide actionable information.

Remarks

Required

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	The lifecycle state of the EnrichmentJob.

Remarks

Required

ModelId

Declaration

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

Property Value

Type	Description
string	The generative AI modelId used for Enrichment. You can use the ListModels API to list the available models. https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels

Remarks

Required

PercentComplete

Declaration

[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }

Property Value

Type	Description
float?	The percentage of the enrichment job that has been completed.

SemanticStoreId

Declaration

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

Property Value

Type	Description
string	Owning SemanticStore OCID for an EnrichmentJob.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeAccepted

Declaration

[Required(ErrorMessage = "TimeAccepted is required.")]
[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }

Property Value

Type	Description
DateTime?	The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	The date and time that the enrichment job was finished in the format of an RFC3339 datetime string.

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	The date and time that the enrichment job was started in the format of an RFC3339 datetime string.