qcrboxapiclient.api.calculations.stop_running_calculation¶
- async qcrboxapiclient.api.calculations.stop_running_calculation.asyncio(id, *, client)¶
Stop a running calculation
Stop a currently running command, interactive and non-interactive.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Return type:
Union
[QCrBoxErrorResponse
,QCrBoxResponseCalculationStoppedResponse
,None
]- Returns:
Union[QCrBoxErrorResponse, QCrBoxResponseCalculationStoppedResponse]
- async qcrboxapiclient.api.calculations.stop_running_calculation.asyncio_detailed(id, *, client)¶
Stop a running calculation
Stop a currently running command, interactive and non-interactive.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Return type:
Response
[Union
[QCrBoxErrorResponse
,QCrBoxResponseCalculationStoppedResponse
]]- Returns:
Response[Union[QCrBoxErrorResponse, QCrBoxResponseCalculationStoppedResponse]]
- qcrboxapiclient.api.calculations.stop_running_calculation.sync(id, *, client)¶
Stop a running calculation
Stop a currently running command, interactive and non-interactive.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Return type:
Union
[QCrBoxErrorResponse
,QCrBoxResponseCalculationStoppedResponse
,None
]- Returns:
Union[QCrBoxErrorResponse, QCrBoxResponseCalculationStoppedResponse]
- qcrboxapiclient.api.calculations.stop_running_calculation.sync_detailed(id, *, client)¶
Stop a running calculation
Stop a currently running command, interactive and non-interactive.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Return type:
Response
[Union
[QCrBoxErrorResponse
,QCrBoxResponseCalculationStoppedResponse
]]- Returns:
Response[Union[QCrBoxErrorResponse, QCrBoxResponseCalculationStoppedResponse]]