GenerateSqlFromNlJob¶

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

Bases: object

Object representing to GenerateSqlFromNlJob. ocidEntityType: generativeaiGenerateSqlFromNlJob adLocality: regional

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob.
`compartment_id`	Gets the compartment_id of this GenerateSqlFromNlJob.
`defined_tags`	Gets the defined_tags of this GenerateSqlFromNlJob.
`description`	Gets the description of this GenerateSqlFromNlJob.
`display_name`	Gets the display_name of this GenerateSqlFromNlJob.
`freeform_tags`	Gets the freeform_tags of this GenerateSqlFromNlJob.
`id`	[Required] Gets the id of this GenerateSqlFromNlJob.
`input_natural_language_query`	Gets the input_natural_language_query of this GenerateSqlFromNlJob.
`job_output`	Gets the job_output of this GenerateSqlFromNlJob.
`lifecycle_details`	[Required] Gets the lifecycle_details of this GenerateSqlFromNlJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this GenerateSqlFromNlJob.
`semantic_store_id`	[Required] Gets the semantic_store_id of this GenerateSqlFromNlJob.
`system_tags`	Gets the system_tags of this GenerateSqlFromNlJob.
`time_accepted`	[Required] Gets the time_accepted of this GenerateSqlFromNlJob.
`time_finished`	Gets the time_finished of this GenerateSqlFromNlJob.
`time_started`	Gets the time_started of this GenerateSqlFromNlJob.

Methods

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a GenerateSqlFromNlJob. 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 GenerateSqlFromNlJob. 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 GenerateSqlFromNlJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new GenerateSqlFromNlJob 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 GenerateSqlFromNlJob.
compartment_id (str) – The value to assign to the compartment_id property of this GenerateSqlFromNlJob.
description (str) – The value to assign to the description property of this GenerateSqlFromNlJob.
semantic_store_id (str) – The value to assign to the semantic_store_id property of this GenerateSqlFromNlJob.
display_name (str) – The value to assign to the display_name property of this GenerateSqlFromNlJob.
time_accepted (datetime) – The value to assign to the time_accepted property of this GenerateSqlFromNlJob.
time_started (datetime) – The value to assign to the time_started property of this GenerateSqlFromNlJob.
time_finished (datetime) – The value to assign to the time_finished property of this GenerateSqlFromNlJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GenerateSqlFromNlJob. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this GenerateSqlFromNlJob.
input_natural_language_query (str) – The value to assign to the input_natural_language_query property of this GenerateSqlFromNlJob.
job_output (oci.generative_ai_data.models.JobOutput) – The value to assign to the job_output property of this GenerateSqlFromNlJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GenerateSqlFromNlJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GenerateSqlFromNlJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this GenerateSqlFromNlJob.

compartment_id¶

Gets the compartment_id of this GenerateSqlFromNlJob. Owning compartmentId OCID for a GenerateSqlFromNlJob.

Returns:	The compartment_id of this GenerateSqlFromNlJob.
Return type:	str

defined_tags¶

Gets the defined_tags of this GenerateSqlFromNlJob. 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 GenerateSqlFromNlJob.
Return type:	dict(str, dict(str, object))

description¶

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

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

display_name¶

Gets the display_name of this GenerateSqlFromNlJob. 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 GenerateSqlFromNlJob.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this GenerateSqlFromNlJob. 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 GenerateSqlFromNlJob.
Return type:	dict(str, str)

id¶

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

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

input_natural_language_query¶

Gets the input_natural_language_query of this GenerateSqlFromNlJob. A user-provided query or instruction written in plain, conversational language. This input is intended to capture the user’s intent, question, or command without requiring technical syntax or structured formatting. The query should clearly express what the user wants to know or accomplish, allowing the system to interpret and respond appropriately.

Returns:	The input_natural_language_query of this GenerateSqlFromNlJob.
Return type:	str

job_output¶

Gets the job_output of this GenerateSqlFromNlJob.

Returns:	The job_output of this GenerateSqlFromNlJob.
Return type:	oci.generative_ai_data.models.JobOutput

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this GenerateSqlFromNlJob. The lifecycleState of GenerateSqlFromNlJob.

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 GenerateSqlFromNlJob.
Return type:	str

semantic_store_id¶

[Required] Gets the semantic_store_id of this GenerateSqlFromNlJob. Owning SemanticStore OCID for a GenerateSqlFromNlJob.

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

system_tags¶

Gets the system_tags of this GenerateSqlFromNlJob. 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 GenerateSqlFromNlJob.
Return type:	dict(str, dict(str, object))

time_accepted¶

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

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

time_finished¶

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

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

time_started¶

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

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