polarion_rest_api_client.open_api_client.api.jobs package¶

Contains endpoint functions for accessing the API.

Submodules¶

polarion_rest_api_client.open_api_client.api.jobs.get_job module¶

async polarion_rest_api_client.open_api_client.api.jobs.get_job.asyncio(job_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | JobsSingleGetResponse | None¶

Returns the specified Job.

Args:: job_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]):
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.
Returns:: Union[Errors, JobsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.jobs.get_job.asyncio_detailed(job_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | JobsSingleGetResponse]¶

Returns the specified Job.

Args:: job_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]):
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.
Returns:: Response[Union[Errors, JobsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.jobs.get_job.sync(job_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | JobsSingleGetResponse | None¶

Returns the specified Job.

Args:: job_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]):
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.
Returns:: Union[Errors, JobsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.jobs.get_job.sync_detailed(job_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | JobsSingleGetResponse]¶

Returns the specified Job.

Args:: job_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]):
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.
Returns:: Response[Union[Errors, JobsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.jobs.get_job_result_file_content module¶

async polarion_rest_api_client.open_api_client.api.jobs.get_job_result_file_content.asyncio(job_id: str, filename: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Downloads the file content for a specified job.

Args:: job_id (str): filename (str):
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.
Returns:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.jobs.get_job_result_file_content.asyncio_detailed(job_id: str, filename: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Downloads the file content for a specified job.

Args:: job_id (str): filename (str):
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.
Returns:: Response[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.jobs.get_job_result_file_content.sync(job_id: str, filename: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Downloads the file content for a specified job.

Args:: job_id (str): filename (str):
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.
Returns:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.jobs.get_job_result_file_content.sync_detailed(job_id: str, filename: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Downloads the file content for a specified job.

Args:: job_id (str): filename (str):
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.
Returns:: Response[Union[Any, Errors]]