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.execute_job module

async polarion_rest_api_client.open_api_client.api.jobs.execute_job.asyncio(*, client: AuthenticatedClient | Client, body: ExecuteJobRequestBody) → Errors | JobsSinglePostResponse | None

Executes a Job.

Args:

body (ExecuteJobRequestBody):

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:

Errors | JobsSinglePostResponse

async polarion_rest_api_client.open_api_client.api.jobs.execute_job.asyncio_detailed(*, client: AuthenticatedClient | Client, body: ExecuteJobRequestBody) → Response[Errors | JobsSinglePostResponse]

Executes a Job.

Args:

body (ExecuteJobRequestBody):

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[Errors | JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.jobs.execute_job.sync(*, client: AuthenticatedClient | Client, body: ExecuteJobRequestBody) → Errors | JobsSinglePostResponse | None

Executes a Job.

Args:

body (ExecuteJobRequestBody):

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:

Errors | JobsSinglePostResponse

polarion_rest_api_client.open_api_client.api.jobs.execute_job.sync_detailed(*, client: AuthenticatedClient | Client, body: ExecuteJobRequestBody) → Response[Errors | JobsSinglePostResponse]

Executes a Job.

Args:

body (ExecuteJobRequestBody):

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[Errors | JobsSinglePostResponse]

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: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | JobsSingleGetResponse | None

Returns the specified Job.

Args:

job_id (str): fields (SparseFields | Unset): include (str | Unset):

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:

Errors | JobsSingleGetResponse

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

Returns the specified Job.

Args:

job_id (str): fields (SparseFields | Unset): include (str | Unset):

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[Errors | JobsSingleGetResponse]

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

Returns the specified Job.

Args:

job_id (str): fields (SparseFields | Unset): include (str | Unset):

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:

Errors | JobsSingleGetResponse

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

Returns the specified Job.

Args:

job_id (str): fields (SparseFields | Unset): include (str | Unset):

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[Errors | JobsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.jobs.get_job_log_content module

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

Downloads the Log content for a specified job.

Args:

job_id (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:

Any | Errors

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

Downloads the Log content for a specified job.

Args:

job_id (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[Any | Errors]

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

Downloads the Log content for a specified job.

Args:

job_id (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:

Any | Errors

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

Downloads the Log content for a specified job.

Args:

job_id (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[Any | Errors]

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:

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[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:

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[Any | Errors]

polarion_rest_api_client.open_api_client.api.jobs.get_jobs module

async polarion_rest_api_client.open_api_client.api.jobs.get_jobs.asyncio(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, project_id: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | JobsListGetResponse | None

Returns the list of Jobs.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): project_id (str | Unset):

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:

Errors | JobsListGetResponse

async polarion_rest_api_client.open_api_client.api.jobs.get_jobs.asyncio_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, project_id: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | JobsListGetResponse]

Returns the list of Jobs.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): project_id (str | Unset):

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[Errors | JobsListGetResponse]

polarion_rest_api_client.open_api_client.api.jobs.get_jobs.sync(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, project_id: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | JobsListGetResponse | None

Returns the list of Jobs.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): project_id (str | Unset):

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:

Errors | JobsListGetResponse

polarion_rest_api_client.open_api_client.api.jobs.get_jobs.sync_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, project_id: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | JobsListGetResponse]

Returns the list of Jobs.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): project_id (str | Unset):

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[Errors | JobsListGetResponse]