StopQueryExecutionResponse¶
- pydantic model openapi_client.models.stop_query_execution_response.StopQueryExecutionResponse¶
Success body for DELETE /queries/{queryid}. Cancellation is requested asynchronously, so QueryStatus reflects the state observed at the time of the call rather than a guaranteed final state.
- Fields:
- field query_id: StrictStr [Required] (alias 'QueryId')¶
Identifier of the query the stop was requested for.
- Constraints:
strict = True
- field query_status: StrictStr [Required] (alias 'QueryStatus')¶
State observed when the stop was processed. CANCELLING means the stop was accepted and is in progress; CANCELLED means the query was already cancelled or the engine confirmed cancellation; SUCCEEDED means the query completed before the stop took effect. For a query already in CANCELLING state the live engine status is returned verbatim, so other states such as RUNNING or FAILED are possible and this field is deliberately not constrained to an enum.
- 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 StopQueryExecutionResponse 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 StopQueryExecutionResponse from a dict
- Return type:
Optional[Self]