Skip to content

job_api

OQTOPUS Cloud User API

OQTOPUS Cloud User API. This API is used to interact with the OQTOPUS Cloud service. The API provides endpoints to manage devices, jobs, and results.

The version of the OpenAPI document: 1.0 Contact: oqtopus-team[at]googlegroups.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Classes:

  • JobApi –

    NOTE: This class is auto generated by OpenAPI Generator

JobApi 

JobApi(api_client=None)

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods:

cancel_job async 

cancel_job(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> SuccessSuccessResponse

Cancel job

Start a procedure to cancel quantum job.

Operation is valid only for job with status: submitted, ready or running.

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

cancel_job_with_http_info async 

cancel_job_with_http_info(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[SuccessSuccessResponse]

Cancel job

Start a procedure to cancel quantum job.

Operation is valid only for job with status: submitted, ready or running.

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

cancel_job_without_preload_content async 

cancel_job_without_preload_content(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Cancel job

Start a procedure to cancel quantum job.

Operation is valid only for job with status: submitted, ready or running.

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

delete_job async 

delete_job(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> SuccessSuccessResponse

Delete job

Deletes quantum job and related result

Operation is valid only for job with status: succeeded, failed and cancelled. submitted, ready and running jobs must be cancelled before deletion.

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

delete_job_with_http_info async 

delete_job_with_http_info(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[SuccessSuccessResponse]

Delete job

Deletes quantum job and related result

Operation is valid only for job with status: succeeded, failed and cancelled. submitted, ready and running jobs must be cancelled before deletion.

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

delete_job_without_preload_content async 

delete_job_without_preload_content(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Delete job

Deletes quantum job and related result

Operation is valid only for job with status: succeeded, failed and cancelled. submitted, ready and running jobs must be cancelled before deletion.

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_job async 

get_job(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> JobsJob

Get selected job

Get selected job

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_job_status async 

get_job_status(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> JobsGetJobStatusResponse

Get selected job's status

Get selected job's status

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_job_status_with_http_info async 

get_job_status_with_http_info(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[JobsGetJobStatusResponse]

Get selected job's status

Get selected job's status

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_job_status_without_preload_content async 

get_job_status_without_preload_content(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Get selected job's status

Get selected job's status

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_job_with_http_info async 

get_job_with_http_info(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[JobsJob]

Get selected job

Get selected job

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

get_job_without_preload_content async 

get_job_without_preload_content(
    job_id: StrictStr,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Get selected job

Get selected job

:param job_id: Job identifier (required) :type job_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

list_jobs async 

list_jobs(
    fields: Optional[str] = None,
    start_time: Optional[datetime] = None,
    end_time: Optional[datetime] = None,
    status: Optional[JobsJobStatus] = None,
    q: Optional[str] = None,
    page: Optional[int] = None,
    size: Optional[int] = None,
    order: Optional[StrictStr] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> List[JobsJob]

List all quantum jobs

By default, all available job's properties are returned. Use 'fields' parameter to specify exact list of properties to get for each job. List of jobs can be filtered by submission time, status or search text with 'start_time', 'end_time', 'status' and 'q' parameters. Jobs are fetched with the pagination mechanism. This can be configured with 'page' and 'perPage' parameters. Check response's 'Link' header for pagination details.

:param fields: Allows to specify an exact list of job properties to fetch for a single job. Each element of the list must be a valid name of job property. If parameter is specified and requested job field is not defined for a job null is returned. If parameter is omitted all available job properties are returned. Undefined job properties (null properties) are not included in the response. :type fields: str :param start_time: Allows to filter the list of jobs to fetch by submission time. If specified only jobs with submission time (submitted_at property) >= start_time are returned. :type start_time: datetime :param end_time: Allows to filter the list of jobs to fetch by to submission time. If specified only jobs with submission time (submitted_at property) <= end_time are returned. :type end_time: datetime :param status: Allows to filter the list of jobs to fetch by job's status. If specified only jobs which status is equal to provided status are returned. :type status: JobsJobStatus :param q: Allows to filter the list of jobs to fetch by job's id, name and description. If specified only jobs which id, name or description contains specified search string are returned. :type q: str :param page: Set jobs list page number to fetch. If requested page number exceeds number of all pages last page is returned. :type page: int :param size: Configure number of jobs per page :type size: int :param order: Specify jobs order according to creation time (createdAt property) :type order: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

list_jobs_with_http_info async 

list_jobs_with_http_info(
    fields: Optional[str] = None,
    start_time: Optional[datetime] = None,
    end_time: Optional[datetime] = None,
    status: Optional[JobsJobStatus] = None,
    q: Optional[str] = None,
    page: Optional[int] = None,
    size: Optional[int] = None,
    order: Optional[StrictStr] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[List[JobsJob]]

List all quantum jobs

By default, all available job's properties are returned. Use 'fields' parameter to specify exact list of properties to get for each job. List of jobs can be filtered by submission time, status or search text with 'start_time', 'end_time', 'status' and 'q' parameters. Jobs are fetched with the pagination mechanism. This can be configured with 'page' and 'perPage' parameters. Check response's 'Link' header for pagination details.

:param fields: Allows to specify an exact list of job properties to fetch for a single job. Each element of the list must be a valid name of job property. If parameter is specified and requested job field is not defined for a job null is returned. If parameter is omitted all available job properties are returned. Undefined job properties (null properties) are not included in the response. :type fields: str :param start_time: Allows to filter the list of jobs to fetch by submission time. If specified only jobs with submission time (submitted_at property) >= start_time are returned. :type start_time: datetime :param end_time: Allows to filter the list of jobs to fetch by to submission time. If specified only jobs with submission time (submitted_at property) <= end_time are returned. :type end_time: datetime :param status: Allows to filter the list of jobs to fetch by job's status. If specified only jobs which status is equal to provided status are returned. :type status: JobsJobStatus :param q: Allows to filter the list of jobs to fetch by job's id, name and description. If specified only jobs which id, name or description contains specified search string are returned. :type q: str :param page: Set jobs list page number to fetch. If requested page number exceeds number of all pages last page is returned. :type page: int :param size: Configure number of jobs per page :type size: int :param order: Specify jobs order according to creation time (createdAt property) :type order: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

list_jobs_without_preload_content async 

list_jobs_without_preload_content(
    fields: Optional[str] = None,
    start_time: Optional[datetime] = None,
    end_time: Optional[datetime] = None,
    status: Optional[JobsJobStatus] = None,
    q: Optional[str] = None,
    page: Optional[int] = None,
    size: Optional[int] = None,
    order: Optional[StrictStr] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

List all quantum jobs

By default, all available job's properties are returned. Use 'fields' parameter to specify exact list of properties to get for each job. List of jobs can be filtered by submission time, status or search text with 'start_time', 'end_time', 'status' and 'q' parameters. Jobs are fetched with the pagination mechanism. This can be configured with 'page' and 'perPage' parameters. Check response's 'Link' header for pagination details.

:param fields: Allows to specify an exact list of job properties to fetch for a single job. Each element of the list must be a valid name of job property. If parameter is specified and requested job field is not defined for a job null is returned. If parameter is omitted all available job properties are returned. Undefined job properties (null properties) are not included in the response. :type fields: str :param start_time: Allows to filter the list of jobs to fetch by submission time. If specified only jobs with submission time (submitted_at property) >= start_time are returned. :type start_time: datetime :param end_time: Allows to filter the list of jobs to fetch by to submission time. If specified only jobs with submission time (submitted_at property) <= end_time are returned. :type end_time: datetime :param status: Allows to filter the list of jobs to fetch by job's status. If specified only jobs which status is equal to provided status are returned. :type status: JobsJobStatus :param q: Allows to filter the list of jobs to fetch by job's id, name and description. If specified only jobs which id, name or description contains specified search string are returned. :type q: str :param page: Set jobs list page number to fetch. If requested page number exceeds number of all pages last page is returned. :type page: int :param size: Configure number of jobs per page :type size: int :param order: Specify jobs order according to creation time (createdAt property) :type order: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

register_job_id async 

register_job_id(
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> JobsRegisterJobResponse

Register new job

Register new job and generate a presigned URL to upload job information (jobs.S3SubmitJobInfo) to OQTOPUS cloud.

:param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

register_job_id_with_http_info async 

register_job_id_with_http_info(
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[JobsRegisterJobResponse]

Register new job

Register new job and generate a presigned URL to upload job information (jobs.S3SubmitJobInfo) to OQTOPUS cloud.

:param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

register_job_id_without_preload_content async 

register_job_id_without_preload_content(
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Register new job

Register new job and generate a presigned URL to upload job information (jobs.S3SubmitJobInfo) to OQTOPUS cloud.

:param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

submit_job async 

submit_job(
    job_id: StrictStr,
    jobs_submit_job_request: Optional[
        JobsSubmitJobRequest
    ] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> SuccessSuccessResponse

Complete submission of a quantum job

Complete submission of a previously registered quantum job. job_id must be created via 'POST /jobs' request. Submit job information (jobs.S3SubmitJobInfo) must be formerly uploaded to OQTOPUS cloud using presigned URL received in 'POST /jobs' response.

:param job_id: Job identifier (required) :type job_id: str :param jobs_submit_job_request: Quantum job to be submitted :type jobs_submit_job_request: JobsSubmitJobRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

submit_job_with_http_info async 

submit_job_with_http_info(
    job_id: StrictStr,
    jobs_submit_job_request: Optional[
        JobsSubmitJobRequest
    ] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> ApiResponse[SuccessSuccessResponse]

Complete submission of a quantum job

Complete submission of a previously registered quantum job. job_id must be created via 'POST /jobs' request. Submit job information (jobs.S3SubmitJobInfo) must be formerly uploaded to OQTOPUS cloud using presigned URL received in 'POST /jobs' response.

:param job_id: Job identifier (required) :type job_id: str :param jobs_submit_job_request: Quantum job to be submitted :type jobs_submit_job_request: JobsSubmitJobRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.

submit_job_without_preload_content async 

submit_job_without_preload_content(
    job_id: StrictStr,
    jobs_submit_job_request: Optional[
        JobsSubmitJobRequest
    ] = None,
    _request_timeout: Union[
        None, StrictFloat, Tuple[StrictFloat, StrictFloat]
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: StrictInt = 0,
) -> RESTResponseType

Complete submission of a quantum job

Complete submission of a previously registered quantum job. job_id must be created via 'POST /jobs' request. Submit job information (jobs.S3SubmitJobInfo) must be formerly uploaded to OQTOPUS cloud using presigned URL received in 'POST /jobs' response.

:param job_id: Job identifier (required) :type job_id: str :param jobs_submit_job_request: Quantum job to be submitted :type jobs_submit_job_request: JobsSubmitJobRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. :type _request_auth: dict, optional :param _content_type: force content-type for the request. :type _content_type: str, Optional :param _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request. :type _headers: dict, optional :param _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request. :type _host_index: int, optional :return: Returns the result object.