1406 lines
56 KiB
Python
1406 lines
56 KiB
Python
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
|
|
from .basesdk import BaseSDK
|
|
from typing import Any, List, Mapping, Optional, Union, cast
|
|
from unstructured_client import utils
|
|
from unstructured_client._hooks import HookContext
|
|
from unstructured_client.models import errors, operations, shared
|
|
from unstructured_client.types import BaseModel, OptionalNullable, UNSET
|
|
from unstructured_client.utils.unmarshal_json_response import unmarshal_json_response
|
|
|
|
|
|
class Jobs(BaseSDK):
|
|
def cancel_job(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.CancelJobRequest, operations.CancelJobRequestTypedDict
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.CancelJobResponse:
|
|
r"""Cancel Job
|
|
|
|
Cancel the specified job.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.CancelJobRequest)
|
|
request = cast(operations.CancelJobRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/api/v1/jobs/{job_id}/cancel",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="cancel_job",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.CancelJobResponse(
|
|
any=unmarshal_json_response(Optional[Any], http_res),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def cancel_job_async(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.CancelJobRequest, operations.CancelJobRequestTypedDict
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.CancelJobResponse:
|
|
r"""Cancel Job
|
|
|
|
Cancel the specified job.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.CancelJobRequest)
|
|
request = cast(operations.CancelJobRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/api/v1/jobs/{job_id}/cancel",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="cancel_job",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.CancelJobResponse(
|
|
any=unmarshal_json_response(Optional[Any], http_res),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
def create_job(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.CreateJobRequest, operations.CreateJobRequestTypedDict
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.CreateJobResponse:
|
|
r"""Create Job
|
|
|
|
Create a new on-demand job using either a template (with persistent job optimization) or custom DAG.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.CreateJobRequest)
|
|
request = cast(operations.CreateJobRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/api/v1/jobs/",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request.body_create_job, False, False, "multipart", shared.BodyCreateJob
|
|
),
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="create_job",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.CreateJobResponse(
|
|
job_information=unmarshal_json_response(
|
|
Optional[shared.JobInformation], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def create_job_async(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.CreateJobRequest, operations.CreateJobRequestTypedDict
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.CreateJobResponse:
|
|
r"""Create Job
|
|
|
|
Create a new on-demand job using either a template (with persistent job optimization) or custom DAG.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.CreateJobRequest)
|
|
request = cast(operations.CreateJobRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/api/v1/jobs/",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request.body_create_job, False, False, "multipart", shared.BodyCreateJob
|
|
),
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="create_job",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.CreateJobResponse(
|
|
job_information=unmarshal_json_response(
|
|
Optional[shared.JobInformation], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
def download_job_output(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.DownloadJobOutputRequest,
|
|
operations.DownloadJobOutputRequestTypedDict,
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.DownloadJobOutputResponse:
|
|
r"""Download Job output
|
|
|
|
Download the output of a job from a workflow where the input file was provided at runtime.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.DownloadJobOutputRequest)
|
|
request = cast(operations.DownloadJobOutputRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}/download",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="download_job_output",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.DownloadJobOutputResponse(
|
|
any=unmarshal_json_response(Optional[Any], http_res),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def download_job_output_async(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.DownloadJobOutputRequest,
|
|
operations.DownloadJobOutputRequestTypedDict,
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.DownloadJobOutputResponse:
|
|
r"""Download Job output
|
|
|
|
Download the output of a job from a workflow where the input file was provided at runtime.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.DownloadJobOutputRequest)
|
|
request = cast(operations.DownloadJobOutputRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}/download",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="download_job_output",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.DownloadJobOutputResponse(
|
|
any=unmarshal_json_response(Optional[Any], http_res),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
def get_job(
|
|
self,
|
|
*,
|
|
request: Union[operations.GetJobRequest, operations.GetJobRequestTypedDict],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetJobResponse:
|
|
r"""Get Job
|
|
|
|
Retrieve detailed information for a specific job by its ID.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.GetJobRequest)
|
|
request = cast(operations.GetJobRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="get_job",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.GetJobResponse(
|
|
job_information=unmarshal_json_response(
|
|
Optional[shared.JobInformation], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def get_job_async(
|
|
self,
|
|
*,
|
|
request: Union[operations.GetJobRequest, operations.GetJobRequestTypedDict],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetJobResponse:
|
|
r"""Get Job
|
|
|
|
Retrieve detailed information for a specific job by its ID.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.GetJobRequest)
|
|
request = cast(operations.GetJobRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="get_job",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.GetJobResponse(
|
|
job_information=unmarshal_json_response(
|
|
Optional[shared.JobInformation], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
def get_job_details(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.GetJobDetailsRequest, operations.GetJobDetailsRequestTypedDict
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetJobDetailsResponse:
|
|
r"""Get Job processing details
|
|
|
|
Retrieve processing details for a specific job by its ID.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.GetJobDetailsRequest)
|
|
request = cast(operations.GetJobDetailsRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}/details",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="get_job_details",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.GetJobDetailsResponse(
|
|
job_details=unmarshal_json_response(
|
|
Optional[shared.JobDetails], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def get_job_details_async(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.GetJobDetailsRequest, operations.GetJobDetailsRequestTypedDict
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetJobDetailsResponse:
|
|
r"""Get Job processing details
|
|
|
|
Retrieve processing details for a specific job by its ID.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.GetJobDetailsRequest)
|
|
request = cast(operations.GetJobDetailsRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}/details",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="get_job_details",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.GetJobDetailsResponse(
|
|
job_details=unmarshal_json_response(
|
|
Optional[shared.JobDetails], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
def get_job_failed_files(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.GetJobFailedFilesRequest,
|
|
operations.GetJobFailedFilesRequestTypedDict,
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetJobFailedFilesResponse:
|
|
r"""Get Job Failed Files
|
|
|
|
Retrieve failed files for a specific job by its ID.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.GetJobFailedFilesRequest)
|
|
request = cast(operations.GetJobFailedFilesRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}/failed-files",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="get_job_failed_files",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.GetJobFailedFilesResponse(
|
|
job_failed_files=unmarshal_json_response(
|
|
Optional[shared.JobFailedFiles], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def get_job_failed_files_async(
|
|
self,
|
|
*,
|
|
request: Union[
|
|
operations.GetJobFailedFilesRequest,
|
|
operations.GetJobFailedFilesRequestTypedDict,
|
|
],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetJobFailedFilesResponse:
|
|
r"""Get Job Failed Files
|
|
|
|
Retrieve failed files for a specific job by its ID.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.GetJobFailedFilesRequest)
|
|
request = cast(operations.GetJobFailedFilesRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/api/v1/jobs/{job_id}/failed-files",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="get_job_failed_files",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.GetJobFailedFilesResponse(
|
|
job_failed_files=unmarshal_json_response(
|
|
Optional[shared.JobFailedFiles], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
def list_jobs(
|
|
self,
|
|
*,
|
|
request: Union[operations.ListJobsRequest, operations.ListJobsRequestTypedDict],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.ListJobsResponse:
|
|
r"""List Jobs
|
|
|
|
Retrieve a list of jobs with optional filtering by workflow ID or job status.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.ListJobsRequest)
|
|
request = cast(operations.ListJobsRequest, request)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/api/v1/jobs/",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="list_jobs",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.ListJobsResponse(
|
|
response_list_jobs=unmarshal_json_response(
|
|
Optional[List[shared.JobInformation]], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|
|
|
|
async def list_jobs_async(
|
|
self,
|
|
*,
|
|
request: Union[operations.ListJobsRequest, operations.ListJobsRequestTypedDict],
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.ListJobsResponse:
|
|
r"""List Jobs
|
|
|
|
Retrieve a list of jobs with optional filtering by workflow ID or job status.
|
|
|
|
:param request: The request object to send.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
if not isinstance(request, BaseModel):
|
|
request = utils.unmarshal(request, operations.ListJobsRequest)
|
|
request = cast(operations.ListJobsRequest, request)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/api/v1/jobs/",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
security=self.sdk_configuration.security,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(3000, 720000, 1.88, 1800000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5xx"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="list_jobs",
|
|
oauth2_scopes=[],
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
error_status_codes=["422", "4XX", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.ListJobsResponse(
|
|
response_list_jobs=unmarshal_json_response(
|
|
Optional[List[shared.JobInformation]], http_res
|
|
),
|
|
status_code=http_res.status_code,
|
|
content_type=http_res.headers.get("Content-Type") or "",
|
|
raw_response=http_res,
|
|
)
|
|
if utils.match_response(http_res, "422", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.HTTPValidationErrorData, http_res
|
|
)
|
|
raise errors.HTTPValidationError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.SDKError("API error occurred", http_res, http_res_text)
|
|
|
|
raise errors.SDKError("Unexpected response received", http_res)
|