QueryWorkbookStopQueriesResponse

pydantic model openapi_client.models.query_workbook_stop_queries_response.QueryWorkbookStopQueriesResponse

Success body for PUT /workbooks/{workbook_id}?action=stop_running_queries.

Fields:
field message: StrictStr [Required] (alias 'Message')

Confirmation message. Reports either that stops were triggered or that no running queries were found; check StoppedQueries rather than matching on this text.

Constraints:

  • strict = True

field stopped_queries: List[StrictStr] [Required] (alias 'StoppedQueries')

IDs of the queries a stop was successfully triggered for. Empty when no queries were running. Queries whose stop call failed are omitted from this list rather than reported, so a partial failure is not distinguishable from a query that was not running.

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 QueryWorkbookStopQueriesResponse 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 QueryWorkbookStopQueriesResponse from a dict

Return type:

Optional[Self]