EnrichmentJob¶

class oci.generative_ai_data.models.EnrichmentJob(**kwargs)¶

Bases: object

Object representing to EnrichmentJob. ocidEntityType: generativeaiEnrichmentJob adLocality: regional

Attributes

`ENRICHMENT_JOB_TYPE_DELTA_REFRESH`	A constant which can be used with the enrichment_job_type property of a EnrichmentJob.
`ENRICHMENT_JOB_TYPE_FULL_BUILD`	A constant which can be used with the enrichment_job_type property of a EnrichmentJob.
`ENRICHMENT_JOB_TYPE_PARTIAL_BUILD`	A constant which can be used with the enrichment_job_type property of a EnrichmentJob.
`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a EnrichmentJob.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a EnrichmentJob.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a EnrichmentJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a EnrichmentJob.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a EnrichmentJob.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a EnrichmentJob.
`defined_tags`	Gets the defined_tags of this EnrichmentJob.
`description`	Gets the description of this EnrichmentJob.
`display_name`	Gets the display_name of this EnrichmentJob.
`enrichment_job_configuration`	[Required] Gets the enrichment_job_configuration of this EnrichmentJob.
`enrichment_job_type`	[Required] Gets the enrichment_job_type of this EnrichmentJob.
`freeform_tags`	Gets the freeform_tags of this EnrichmentJob.
`id`	[Required] Gets the id of this EnrichmentJob.
`lifecycle_details`	[Required] Gets the lifecycle_details of this EnrichmentJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this EnrichmentJob.
`percent_complete`	Gets the percent_complete of this EnrichmentJob.
`semantic_store_id`	[Required] Gets the semantic_store_id of this EnrichmentJob.
`system_tags`	Gets the system_tags of this EnrichmentJob.
`time_accepted`	[Required] Gets the time_accepted of this EnrichmentJob.
`time_finished`	Gets the time_finished of this EnrichmentJob.
`time_started`	Gets the time_started of this EnrichmentJob.

Methods

__init__(**kwargs) Initializes a new EnrichmentJob object with values from keyword arguments.

ENRICHMENT_JOB_TYPE_DELTA_REFRESH = 'DELTA_REFRESH'¶: A constant which can be used with the enrichment_job_type property of a EnrichmentJob. This constant has a value of “DELTA_REFRESH”

ENRICHMENT_JOB_TYPE_FULL_BUILD = 'FULL_BUILD'¶: A constant which can be used with the enrichment_job_type property of a EnrichmentJob. This constant has a value of “FULL_BUILD”

ENRICHMENT_JOB_TYPE_PARTIAL_BUILD = 'PARTIAL_BUILD'¶: A constant which can be used with the enrichment_job_type property of a EnrichmentJob. This constant has a value of “PARTIAL_BUILD”

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a EnrichmentJob. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a EnrichmentJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a EnrichmentJob. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a EnrichmentJob. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a EnrichmentJob. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a EnrichmentJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new EnrichmentJob object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this EnrichmentJob.
description (str) – The value to assign to the description property of this EnrichmentJob.
semantic_store_id (str) – The value to assign to the semantic_store_id property of this EnrichmentJob.
display_name (str) – The value to assign to the display_name property of this EnrichmentJob.
enrichment_job_type (str) – The value to assign to the enrichment_job_type property of this EnrichmentJob. Allowed values for this property are: “FULL_BUILD”, “PARTIAL_BUILD”, “DELTA_REFRESH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
enrichment_job_configuration (oci.generative_ai_data.models.EnrichmentJobConfiguration) – The value to assign to the enrichment_job_configuration property of this EnrichmentJob.
time_accepted (datetime) – The value to assign to the time_accepted property of this EnrichmentJob.
time_started (datetime) – The value to assign to the time_started property of this EnrichmentJob.
time_finished (datetime) – The value to assign to the time_finished property of this EnrichmentJob.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this EnrichmentJob.
percent_complete (float) – The value to assign to the percent_complete property of this EnrichmentJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EnrichmentJob. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EnrichmentJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EnrichmentJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EnrichmentJob.

defined_tags¶

Gets the defined_tags of this EnrichmentJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this EnrichmentJob.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this EnrichmentJob. An optional description of the EnrichmentJob.

Returns:	The description of this EnrichmentJob.
Return type:	str

display_name¶

Gets the display_name of this EnrichmentJob. A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:	The display_name of this EnrichmentJob.
Return type:	str

enrichment_job_configuration¶

[Required] Gets the enrichment_job_configuration of this EnrichmentJob.

Returns:	The enrichment_job_configuration of this EnrichmentJob.
Return type:	oci.generative_ai_data.models.EnrichmentJobConfiguration

enrichment_job_type¶

[Required] Gets the enrichment_job_type of this EnrichmentJob. Enrichment job type. Currently supported Full Build (All supported objects in a given schema) and Partial Build (Selected tables and/or supported objects in a given schema).

Allowed values for this property are: “FULL_BUILD”, “PARTIAL_BUILD”, “DELTA_REFRESH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The enrichment_job_type of this EnrichmentJob.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this EnrichmentJob. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this EnrichmentJob.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this EnrichmentJob. Unique identifier that is immutable on creation.

Returns:	The id of this EnrichmentJob.
Return type:	str

lifecycle_details¶

[Required] Gets the lifecycle_details of this EnrichmentJob. A message describing the current state in more detail that can provide actionable information.

Returns:	The lifecycle_details of this EnrichmentJob.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this EnrichmentJob. The lifecycleState of GenerateSqlJob.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this EnrichmentJob.
Return type:	str

percent_complete¶

Gets the percent_complete of this EnrichmentJob. The percentage of the enrichment job that has been completed.

Returns:	The percent_complete of this EnrichmentJob.
Return type:	float

semantic_store_id¶

[Required] Gets the semantic_store_id of this EnrichmentJob. Owning SemanticStore OCID for an EnrichmentJob.

Returns:	The semantic_store_id of this EnrichmentJob.
Return type:	str

system_tags¶

Gets the system_tags of this EnrichmentJob. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this EnrichmentJob.
Return type:	dict(str, dict(str, object))

time_accepted¶

[Required] Gets the time_accepted of this EnrichmentJob. The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.

Returns:	The time_accepted of this EnrichmentJob.
Return type:	datetime

time_finished¶

Gets the time_finished of this EnrichmentJob. The date and time that the enrichment job was finished in the format of an RFC3339 datetime string.

Returns:	The time_finished of this EnrichmentJob.
Return type:	datetime

time_started¶

Gets the time_started of this EnrichmentJob. The date and time that the enrichment job was started in the format of an RFC3339 datetime string.

Returns:	The time_started of this EnrichmentJob.
Return type:	datetime