NL2SQLSyncJobTriggerResponse¶
- pydantic model openapi_client.models.nl2_sql_sync_job_trigger_response.NL2SQLSyncJobTriggerResponse¶
Success body for POST /nl2sql/sync-jobs. The sync runs asynchronously: a 200 means the job was started, not that ingestion has finished. Poll GET /nl2sql/sync-jobs and match on RunId to follow its progress.
- Fields:
- field run_id: StrictStr [Required] (alias 'RunId')¶
Identifier of the ingestion run that was started. Use it to correlate with the entries returned by GET /nl2sql/sync-jobs.
- Constraints:
strict = True
- field message: StrictStr [Required] (alias 'Message')¶
Confirmation message.
- Constraints:
strict = True
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of NL2SQLSyncJobTriggerResponse from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of NL2SQLSyncJobTriggerResponse from a dict
- Return type:
Optional[Self]