EnrichmentJobSummary¶
- class oci.generative_ai_data.models.EnrichmentJobSummary(**kwargs)¶
Bases:
objectObject representing EnrichmentJobSummary resource.
Attributes:
A constant which can be used with the enrichment_job_type property of a EnrichmentJobSummary.
A constant which can be used with the enrichment_job_type property of a EnrichmentJobSummary.
A constant which can be used with the enrichment_job_type property of a EnrichmentJobSummary.
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary.
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary.
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary.
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary.
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary.
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary.
Gets the defined_tags of this EnrichmentJobSummary.
Gets the display_name of this EnrichmentJobSummary.
[Required] Gets the enrichment_job_type of this EnrichmentJobSummary.
Gets the freeform_tags of this EnrichmentJobSummary.
[Required] Gets the id of this EnrichmentJobSummary.
[Required] Gets the lifecycle_state of this EnrichmentJobSummary.
[Required] Gets the model_id of this EnrichmentJobSummary.
[Required] Gets the semantic_store_id of this EnrichmentJobSummary.
Gets the system_tags of this EnrichmentJobSummary.
[Required] Gets the time_accepted of this EnrichmentJobSummary.
Methods:
__init__(**kwargs)Initializes a new EnrichmentJobSummary 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 EnrichmentJobSummary. 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 EnrichmentJobSummary. 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 EnrichmentJobSummary. 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 EnrichmentJobSummary. This constant has a value of “ACCEPTED”
- LIFECYCLE_STATE_CANCELED = 'CANCELED'¶
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary. This constant has a value of “CANCELED”
- LIFECYCLE_STATE_CANCELING = 'CANCELING'¶
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary. This constant has a value of “CANCELING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a EnrichmentJobSummary. 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 EnrichmentJobSummary. 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 EnrichmentJobSummary. This constant has a value of “SUCCEEDED”
- __init__(**kwargs)¶
Initializes a new EnrichmentJobSummary 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 EnrichmentJobSummary.
semantic_store_id (str) – The value to assign to the semantic_store_id property of this EnrichmentJobSummary.
display_name (str) – The value to assign to the display_name property of this EnrichmentJobSummary.
enrichment_job_type (str) – The value to assign to the enrichment_job_type property of this EnrichmentJobSummary. 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’.
model_id (str) – The value to assign to the model_id property of this EnrichmentJobSummary.
time_accepted (datetime) – The value to assign to the time_accepted property of this EnrichmentJobSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EnrichmentJobSummary. 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 EnrichmentJobSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EnrichmentJobSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EnrichmentJobSummary.
- property defined_tags¶
Gets the defined_tags of this EnrichmentJobSummary. 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 EnrichmentJobSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this EnrichmentJobSummary. 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 EnrichmentJobSummary.
- Return type
str
- property enrichment_job_type¶
[Required] Gets the enrichment_job_type of this EnrichmentJobSummary. 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).
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 EnrichmentJobSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this EnrichmentJobSummary. 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 EnrichmentJobSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this EnrichmentJobSummary. The OCID of the Semantic Store job.
- Returns
The id of this EnrichmentJobSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this EnrichmentJobSummary. The lifecycle state of the 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’.
- Returns
The lifecycle_state of this EnrichmentJobSummary.
- Return type
str
- property model_id¶
[Required] Gets the model_id of this EnrichmentJobSummary. 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
- Returns
The model_id of this EnrichmentJobSummary.
- Return type
str
- property semantic_store_id¶
[Required] Gets the semantic_store_id of this EnrichmentJobSummary. Owning SemanticStore OCID for the EnrichmentJob.
- Returns
The semantic_store_id of this EnrichmentJobSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this EnrichmentJobSummary. 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 EnrichmentJobSummary.
- Return type
dict(str, dict(str, object))
- property time_accepted¶
[Required] Gets the time_accepted of this EnrichmentJobSummary. The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.
- Returns
The time_accepted of this EnrichmentJobSummary.
- Return type
datetime