scaleway.qaas.v1alpha1 package

Submodules

scaleway.qaas.v1alpha1.api module

class scaleway.qaas.v1alpha1.api.QaasV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage Scaleway Quantum as a Service.

cancel_job(*, job_id: str) → Job

Cancel a job. Cancel the job corresponding to the provided job ID. :param job_id: Unique ID of the job. :return: Job

Usage:

result = api.cancel_job(
    job_id="example",
)

cancel_process(*, process_id: str) → Process

Cancel a running process. Cancel a process by its unique ID. Intermediate results are still available. :param process_id: Unique ID of the process. :return: Process

Usage:

result = api.cancel_process(
    process_id="example",
)

create_job(*, name: str, session_id: str, circuit: JobCircuit, tags: Optional[List[str]] = None, max_duration: Optional[str] = None) → Job

Create a job. Create a job to be executed inside a session. :param name: Name of the job. :param session_id: Session in which the job is executed. :param circuit: Quantum circuit that should be executed. :param tags: Tags of the job. :param max_duration: Maximum duration of the job. :return: Job

Usage:

result = api.create_job(
    name="example",
    session_id="example",
    circuit=JobCircuit(),
)

create_process(*, name: str, project_id: Optional[str] = None, platform_id: Optional[str] = None, application_id: Optional[str] = None, input: Optional[str] = None, tags: Optional[List[str]] = None) → Process

Create a process. Create a new process for the specified application on a specified platform. :param name: Name of the process. :param project_id: ID of the project in which the process was created. :param platform_id: ID of the platform for which the process was created. :param application_id: ID of the application for which the process was created. :param input: Process parameters in JSON format. :param tags: Tags of the process. :return: Process

Usage:

result = api.create_process(
    name="example",
)

create_session(*, platform_id: str, project_id: Optional[str] = None, name: Optional[str] = None, max_idle_duration: Optional[str] = None, max_duration: Optional[str] = None, tags: Optional[List[str]] = None, deduplication_id: Optional[str] = None) → Session

Create a session. Create a dedicated session for the specified platform. :param platform_id: ID of the Platform for which the session was created. :param project_id: ID of the Project in which the session was created. :param name: Name of the session. :param max_idle_duration: Maximum idle duration before the session ends. :param max_duration: Maximum duration before the session ends. :param tags: Tags of the session. :param deduplication_id: Deduplication ID of the session. :return: Session

Usage:

result = api.create_session(
    platform_id="example",
)

delete_job(*, job_id: str) → None

Delete a job. Delete the job corresponding to the provided job ID. :param job_id: Unique ID of the job.

Usage:

result = api.delete_job(
    job_id="example",
)

delete_process(*, process_id: str) → None

Delete an existing process. Delete a process by its unique ID and delete all its data. :param process_id: Unique ID of the process.

Usage:

result = api.delete_process(
    process_id="example",
)

delete_session(*, session_id: str) → None

Delete an existing session. Delete a session by its unique ID and delete all its attached jobs. :param session_id: Unique ID of the session.

Usage:

result = api.delete_session(
    session_id="example",
)

get_application(*, application_id: str) → Application

Get application information. Retrieve information about the provided applcation ID, such as name, type and compatible platforms. :param application_id: Unique ID of the application. :return: Application

Usage:

result = api.get_application(
    application_id="example",
)

get_job(*, job_id: str) → Job

Get job information. Retrieve information about the provided job ID, such as status, payload, and result. :param job_id: Unique ID of the job you want to get. :return: Job

Usage:

result = api.get_job(
    job_id="example",
)

get_job_circuit(*, job_id: str) → JobCircuit

Get a job circuit. Retrieve the circuit of the provided job ID. :param job_id: Unique ID of the job. :return: JobCircuit

Usage:

result = api.get_job_circuit(
    job_id="example",
)

get_platform(*, platform_id: str) → Platform

Get platform information. Retrieve information about the provided platform ID, such as provider name, technology, and type. :param platform_id: Unique ID of the platform. :return: Platform

Usage:

result = api.get_platform(
    platform_id="example",
)

get_process(*, process_id: str) → Process

Get process infrormation. Retrieve information about the provided process ID, such as name, status and progress. :param process_id: Unique ID of the process. :return: Process

Usage:

result = api.get_process(
    process_id="example",
)

get_session(*, session_id: str) → Session

Get session infrormation. Retrieve information about the provided session ID, such as name, status, and number of executed jobs. :param session_id: Unique ID of the session. :return: Session

Usage:

result = api.get_session(
    session_id="example",
)

list_applications(*, name: Optional[str] = None, application_type: Optional[ApplicationType] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListApplicationsRequestOrderBy] = None) → ListApplicationsResponse

List all available applications. Retrieve information about all applications. :param name: List applications with this name. :param application_type: List applications with this type. :param page: Page number. :param page_size: Maximum number of applications a to return per page. :param order_by: Sort order of the returned applications. :return: ListApplicationsResponse

Usage:

result = api.list_applications()

list_applications_all(*, name: Optional[str] = None, application_type: Optional[ApplicationType] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListApplicationsRequestOrderBy] = None) → List[Application]

List all available applications. Retrieve information about all applications. :param name: List applications with this name. :param application_type: List applications with this type. :param page: Page number. :param page_size: Maximum number of applications a to return per page. :param order_by: Sort order of the returned applications. :return: List[Application]

Usage:

result = api.list_applications_all()

list_job_results(*, job_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobResultsRequestOrderBy] = None) → ListJobResultsResponse

List all results of a job. Retrieve all intermediate and final results of a job. :param job_id: ID of the job. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: ListJobResultsResponse

Usage:

result = api.list_job_results(
    job_id="example",
)

list_job_results_all(*, job_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobResultsRequestOrderBy] = None) → List[JobResult]

List all results of a job. Retrieve all intermediate and final results of a job. :param job_id: ID of the job. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: List[JobResult]

Usage:

result = api.list_job_results_all(
    job_id="example",
)

list_jobs(*, session_id: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobsRequestOrderBy] = None) → ListJobsResponse

List all jobs within a project or session. Retrieve information about all jobs within a given project or session. :param session_id: List jobs with this session ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param project_id: List jobs with this project ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param tags: List jobs with these tags. :param page: Page number. :param page_size: Maximum number of jobs to return per page. :param order_by: Sort order of the returned jobs. :return: ListJobsResponse

Usage:

result = api.list_jobs()

list_jobs_all(*, session_id: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobsRequestOrderBy] = None) → List[Job]

List all jobs within a project or session. Retrieve information about all jobs within a given project or session. :param session_id: List jobs with this session ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param project_id: List jobs with this project ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param tags: List jobs with these tags. :param page: Page number. :param page_size: Maximum number of jobs to return per page. :param order_by: Sort order of the returned jobs. :return: List[Job]

Usage:

result = api.list_jobs_all()

list_platforms(*, provider_name: Optional[str] = None, backend_name: Optional[str] = None, name: Optional[str] = None, platform_type: Optional[PlatformType] = None, platform_technology: Optional[PlatformTechnology] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListPlatformsRequestOrderBy] = None) → ListPlatformsResponse

List all available platforms. Retrieve information about all platforms. :param provider_name: List platforms with this provider name. :param backend_name: List platforms with this backend name. :param name: List platforms with this name. :param platform_type: List platforms with this type. :param platform_technology: List platforms with this technology. :param page: Page number. :param page_size: Maximum number of platforms to return per page. :param order_by: Sort order of the returned platforms. :return: ListPlatformsResponse

Usage:

result = api.list_platforms()

list_platforms_all(*, provider_name: Optional[str] = None, backend_name: Optional[str] = None, name: Optional[str] = None, platform_type: Optional[PlatformType] = None, platform_technology: Optional[PlatformTechnology] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListPlatformsRequestOrderBy] = None) → List[Platform]

List all available platforms. Retrieve information about all platforms. :param provider_name: List platforms with this provider name. :param backend_name: List platforms with this backend name. :param name: List platforms with this name. :param platform_type: List platforms with this type. :param platform_technology: List platforms with this technology. :param page: Page number. :param page_size: Maximum number of platforms to return per page. :param order_by: Sort order of the returned platforms. :return: List[Platform]

Usage:

result = api.list_platforms_all()

list_process_results(*, process_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessResultsRequestOrderBy] = None) → ListProcessResultsResponse

List all results of a process. Retrieve all intermediate and final result of a process. :param process_id: ID of the process. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: ListProcessResultsResponse

Usage:

result = api.list_process_results(
    process_id="example",
)

list_process_results_all(*, process_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessResultsRequestOrderBy] = None) → List[ProcessResult]

List all results of a process. Retrieve all intermediate and final result of a process. :param process_id: ID of the process. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: List[ProcessResult]

Usage:

result = api.list_process_results_all(
    process_id="example",
)

list_processes(*, application_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessesRequestOrderBy] = None, project_id: Optional[str] = None) → ListProcessesResponse

List all processes. Retrieve information about all processes. :param application_id: List processes that have been created for this application. :param tags: List processes with these tags. :param page: Page number. :param page_size: Maximum number of processes to return per page. :param order_by: Sort order of the returned processes. :param project_id: List processes belonging to this project ID. :return: ListProcessesResponse

Usage:

result = api.list_processes()

list_processes_all(*, application_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessesRequestOrderBy] = None, project_id: Optional[str] = None) → List[Process]

List all processes. Retrieve information about all processes. :param application_id: List processes that have been created for this application. :param tags: List processes with these tags. :param page: Page number. :param page_size: Maximum number of processes to return per page. :param order_by: Sort order of the returned processes. :param project_id: List processes belonging to this project ID. :return: List[Process]

Usage:

result = api.list_processes_all()

list_session_ac_ls(*, session_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionACLsRequestOrderBy] = None) → ListSessionACLsResponse

Parameters:

• session_id –

• page –

• page_size –

• order_by –

Returns:

ListSessionACLsResponse

Usage:

result = api.list_session_ac_ls(
    session_id="example",
)

list_session_ac_ls_all(*, session_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionACLsRequestOrderBy] = None) → List[SessionAccess]

Parameters:

• session_id –

• page –

• page_size –

• order_by –

Returns:

List[SessionAccess]

Usage:

result = api.list_session_ac_ls_all(
    session_id="example",
)

list_sessions(*, platform_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionsRequestOrderBy] = None, project_id: Optional[str] = None) → ListSessionsResponse

List all sessions. Retrieve information about all sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. :param page_size: Maximum number of sessions to return per page. :param order_by: Sort order of the returned sessions. :param project_id: List sessions belonging to this project ID. :return: ListSessionsResponse

Usage:

result = api.list_sessions()

list_sessions_all(*, platform_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionsRequestOrderBy] = None, project_id: Optional[str] = None) → List[Session]

List all sessions. Retrieve information about all sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. :param page_size: Maximum number of sessions to return per page. :param order_by: Sort order of the returned sessions. :param project_id: List sessions belonging to this project ID. :return: List[Session]

Usage:

result = api.list_sessions_all()

terminate_session(*, session_id: str) → Session

Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs. :param session_id: Unique ID of the session. :return: Session

Usage:

result = api.terminate_session(
    session_id="example",
)

update_job(*, job_id: str, name: Optional[str] = None, tags: Optional[List[str]] = None) → Job

Update job information. Update job information about the provided job ID. :param job_id: Unique ID of the job. :param name: Name of the job. :param tags: Tags of the job. :return: Job

Usage:

result = api.update_job(
    job_id="example",
)

update_process(*, process_id: str, name: Optional[str] = None, tags: Optional[List[str]] = None) → Process

Update process information. Update process information of the provided process ID. :param process_id: Unique ID of the process. :param name: Name of the process. :param tags: Tags of the process. :return: Process

Usage:

result = api.update_process(
    process_id="example",
)

update_session(*, session_id: str, name: Optional[str] = None, max_idle_duration: Optional[str] = None, max_duration: Optional[str] = None, tags: Optional[List[str]] = None) → Session

Update session information. Update session information of the provided session ID. :param session_id: Unique ID of the session. :param name: Name of the session. :param max_idle_duration: Maximum idle duration before the session ends. :param max_duration: Maximum time before the session ends. :param tags: Tags of the session. :return: Session

Usage:

result = api.update_session(
    session_id="example",
)

wait_for_job(*, job_id: str, options: Optional[WaitForOptions[Job, bool]] = None) → Job

Get job information. Retrieve information about the provided job ID, such as status, payload, and result. :param job_id: Unique ID of the job you want to get. :return: Job

Usage:

result = api.get_job(
    job_id="example",
)

wait_for_process(*, process_id: str, options: Optional[WaitForOptions[Process, bool]] = None) → Process

Get process infrormation. Retrieve information about the provided process ID, such as name, status and progress. :param process_id: Unique ID of the process. :return: Process

Usage:

result = api.get_process(
    process_id="example",
)

wait_for_session(*, session_id: str, options: Optional[WaitForOptions[Session, bool]] = None) → Session

Get session infrormation. Retrieve information about the provided session ID, such as name, status, and number of executed jobs. :param session_id: Unique ID of the session. :return: Session

Usage:

result = api.get_session(
    session_id="example",
)

scaleway.qaas.v1alpha1.content module

scaleway.qaas.v1alpha1.content.JOB_TRANSIENT_STATUSES: List[JobStatus] = [<JobStatus.WAITING: 'waiting'>, <JobStatus.RUNNING: 'running'>, <JobStatus.CANCELLING: 'cancelling'>]

Lists transient statutes of the enum JobStatus.

scaleway.qaas.v1alpha1.content.PROCESS_TRANSIENT_STATUSES: List[ProcessStatus] = [<ProcessStatus.STARTING: 'starting'>, <ProcessStatus.RUNNING: 'running'>, <ProcessStatus.CANCELLING: 'cancelling'>]

Lists transient statutes of the enum ProcessStatus.

scaleway.qaas.v1alpha1.content.SESSION_TRANSIENT_STATUSES: List[SessionStatus] = [<SessionStatus.STARTING: 'starting'>, <SessionStatus.STOPPING: 'stopping'>]

Lists transient statutes of the enum SessionStatus.

scaleway.qaas.v1alpha1.marshalling module

scaleway.qaas.v1alpha1.marshalling.marshal_CreateJobRequest(request: CreateJobRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.marshal_CreateProcessRequest(request: CreateProcessRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.marshal_CreateSessionRequest(request: CreateSessionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.marshal_JobCircuit(request: JobCircuit, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.marshal_UpdateJobRequest(request: UpdateJobRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.marshal_UpdateProcessRequest(request: UpdateProcessRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.marshal_UpdateSessionRequest(request: UpdateSessionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.qaas.v1alpha1.marshalling.unmarshal_Application(data: Any) → Application

scaleway.qaas.v1alpha1.marshalling.unmarshal_Job(data: Any) → Job

scaleway.qaas.v1alpha1.marshalling.unmarshal_JobCircuit(data: Any) → JobCircuit

scaleway.qaas.v1alpha1.marshalling.unmarshal_JobResult(data: Any) → JobResult

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListApplicationsResponse(data: Any) → ListApplicationsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListJobResultsResponse(data: Any) → ListJobResultsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListJobsResponse(data: Any) → ListJobsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListPlatformsResponse(data: Any) → ListPlatformsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListProcessResultsResponse(data: Any) → ListProcessResultsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListProcessesResponse(data: Any) → ListProcessesResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListSessionACLsResponse(data: Any) → ListSessionACLsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_ListSessionsResponse(data: Any) → ListSessionsResponse

scaleway.qaas.v1alpha1.marshalling.unmarshal_Platform(data: Any) → Platform

scaleway.qaas.v1alpha1.marshalling.unmarshal_PlatformHardware(data: Any) → PlatformHardware

scaleway.qaas.v1alpha1.marshalling.unmarshal_Process(data: Any) → Process

scaleway.qaas.v1alpha1.marshalling.unmarshal_ProcessResult(data: Any) → ProcessResult

scaleway.qaas.v1alpha1.marshalling.unmarshal_Session(data: Any) → Session

scaleway.qaas.v1alpha1.types module

class scaleway.qaas.v1alpha1.types.Application(id: 'str', name: 'str', type_: 'ApplicationType', compatible_platform_ids: 'List[str]', input_template: 'str')

Bases: object

compatible_platform_ids: List[str]

List of compatible platform (by IDs) able to run this application.

id: str

Unique ID of the application.

input_template: str

JSON format describing the expected input.

name: str

Name of the application.

type_: ApplicationType

Type of the application.

class scaleway.qaas.v1alpha1.types.ApplicationType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

UNKNOWN_TYPE = 'unknown_type'

VQE = 'vqe'

class scaleway.qaas.v1alpha1.types.CancelJobRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job.

class scaleway.qaas.v1alpha1.types.CancelProcessRequest(process_id: 'str')

Bases: object

process_id: str

Unique ID of the process.

class scaleway.qaas.v1alpha1.types.CreateJobRequest(name: 'str', session_id: 'str', circuit: 'JobCircuit', tags: 'Optional[List[str]]', max_duration: 'Optional[str]')

Bases: object

circuit: JobCircuit

Quantum circuit that should be executed.

max_duration: Optional[str]

Maximum duration of the job.

name: str

Name of the job.

session_id: str

Session in which the job is executed.

tags: Optional[List[str]]

Tags of the job.

class scaleway.qaas.v1alpha1.types.CreateProcessRequest(name: 'str', project_id: 'Optional[str]', platform_id: 'Optional[str]', application_id: 'Optional[str]', input: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

application_id: Optional[str]

ID of the application for which the process was created.

input: Optional[str]

Process parameters in JSON format.

name: str

Name of the process.

platform_id: Optional[str]

ID of the platform for which the process was created.

project_id: Optional[str]

ID of the project in which the process was created.

tags: Optional[List[str]]

Tags of the process.

class scaleway.qaas.v1alpha1.types.CreateSessionRequest(platform_id: 'str', project_id: 'Optional[str]', name: 'Optional[str]', max_idle_duration: 'Optional[str]', max_duration: 'Optional[str]', tags: 'Optional[List[str]]', deduplication_id: 'Optional[str]')

Bases: object

deduplication_id: Optional[str]

Deduplication ID of the session.

max_duration: Optional[str]

Maximum duration before the session ends.

max_idle_duration: Optional[str]

Maximum idle duration before the session ends.

name: Optional[str]

Name of the session.

platform_id: str

ID of the Platform for which the session was created.

project_id: Optional[str]

ID of the Project in which the session was created.

tags: Optional[List[str]]

Tags of the session.

class scaleway.qaas.v1alpha1.types.DeleteJobRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job.

class scaleway.qaas.v1alpha1.types.DeleteProcessRequest(process_id: 'str')

Bases: object

process_id: str

Unique ID of the process.

class scaleway.qaas.v1alpha1.types.DeleteSessionRequest(session_id: 'str')

Bases: object

session_id: str

Unique ID of the session.

class scaleway.qaas.v1alpha1.types.GetApplicationRequest(application_id: 'str')

Bases: object

application_id: str

Unique ID of the application.

class scaleway.qaas.v1alpha1.types.GetJobCircuitRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job.

class scaleway.qaas.v1alpha1.types.GetJobRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job you want to get.

class scaleway.qaas.v1alpha1.types.GetPlatformRequest(platform_id: 'str')

Bases: object

platform_id: str

Unique ID of the platform.

class scaleway.qaas.v1alpha1.types.GetProcessRequest(process_id: 'str')

Bases: object

process_id: str

Unique ID of the process.

class scaleway.qaas.v1alpha1.types.GetSessionRequest(session_id: 'str')

Bases: object

session_id: str

Unique ID of the session.

class scaleway.qaas.v1alpha1.types.Job(id: 'str', name: 'str', session_id: 'str', status: 'JobStatus', tags: 'Optional[List[str]]', created_at: 'Optional[datetime]', started_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', progress_message: 'Optional[str]', job_duration: 'Optional[str]', result_distribution: 'Optional[str]')

Bases: object

created_at: Optional[datetime]

Time at which the job was created.

id: str

Unique ID of the job.

job_duration: Optional[str]

Duration of the job, if the job is finished.

name: str

Job name.

progress_message: Optional[str]

Last progress message, if the job has started.

result_distribution: Optional[str]

Result of the job, if the job is finished.

session_id: str

Session ID in which the job is executed.

started_at: Optional[datetime]

Time at which the job was started.

status: JobStatus

Job status.

tags: Optional[List[str]]

Tags of the job.

updated_at: Optional[datetime]

Time at which the job was updated.

class scaleway.qaas.v1alpha1.types.JobCircuit(perceval_circuit: 'Optional[str]', qiskit_circuit: 'Optional[str]')

Bases: object

perceval_circuit: Optional[str]

qiskit_circuit: Optional[str]

class scaleway.qaas.v1alpha1.types.JobResult(job_id: 'str', result: 'Optional[str]', url: 'Optional[str]', created_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation time of the result.

job_id: str

ID of the parent job.

result: Optional[str]

Result in JSON format.

url: Optional[str]

URL to download a large result (optional).

class scaleway.qaas.v1alpha1.types.JobStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CANCELLED = 'cancelled'

CANCELLING = 'cancelling'

COMPLETED = 'completed'

ERROR = 'error'

RUNNING = 'running'

UNKNOWN_STATUS = 'unknown_status'

WAITING = 'waiting'

class scaleway.qaas.v1alpha1.types.ListApplicationsRequest(name: 'Optional[str]', application_type: 'Optional[ApplicationType]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListApplicationsRequestOrderBy]')

Bases: object

application_type: Optional[ApplicationType]

List applications with this type.

name: Optional[str]

List applications with this name.

order_by: Optional[ListApplicationsRequestOrderBy]

Sort order of the returned applications.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of applications a to return per page.

class scaleway.qaas.v1alpha1.types.ListApplicationsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

TYPE_ASC = 'type_asc'

TYPE_DESC = 'type_desc'

class scaleway.qaas.v1alpha1.types.ListApplicationsResponse(total_count: 'int', applications: 'List[Application]')

Bases: object

applications: List[Application]

List of applications.

total_count: int

Total number of applications.

class scaleway.qaas.v1alpha1.types.ListJobResultsRequest(job_id: 'str', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListJobResultsRequestOrderBy]')

Bases: object

job_id: str

ID of the job.

order_by: Optional[ListJobResultsRequestOrderBy]

Sort order of the returned results.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of results to return per page.

class scaleway.qaas.v1alpha1.types.ListJobResultsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.qaas.v1alpha1.types.ListJobResultsResponse(total_count: 'int', job_results: 'List[JobResult]')

Bases: object

job_results: List[JobResult]

List of results.

total_count: int

Total number of results.

class scaleway.qaas.v1alpha1.types.ListJobsRequest(tags: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListJobsRequestOrderBy]', session_id: 'Optional[str]', project_id: 'Optional[str]')

Bases: object

order_by: Optional[ListJobsRequestOrderBy]

Sort order of the returned jobs.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of jobs to return per page.

project_id: Optional[str]

session_id: Optional[str]

tags: Optional[List[str]]

List jobs with these tags.

class scaleway.qaas.v1alpha1.types.ListJobsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

PLATFORM_NAME_ASC = 'platform_name_asc'

PLATFORM_NAME_DESC = 'platform_name_desc'

SESSION_NAME_ASC = 'session_name_asc'

SESSION_NAME_DESC = 'session_name_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.qaas.v1alpha1.types.ListJobsResponse(total_count: 'int', jobs: 'List[Job]')

Bases: object

jobs: List[Job]

List of jobs.

total_count: int

Total number of jobs.

class scaleway.qaas.v1alpha1.types.ListPlatformsRequest(provider_name: 'Optional[str]', backend_name: 'Optional[str]', name: 'Optional[str]', platform_type: 'Optional[PlatformType]', platform_technology: 'Optional[PlatformTechnology]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListPlatformsRequestOrderBy]')

Bases: object

backend_name: Optional[str]

List platforms with this backend name.

name: Optional[str]

List platforms with this name.

order_by: Optional[ListPlatformsRequestOrderBy]

Sort order of the returned platforms.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of platforms to return per page.

platform_technology: Optional[PlatformTechnology]

List platforms with this technology.

platform_type: Optional[PlatformType]

List platforms with this type.

provider_name: Optional[str]

List platforms with this provider name.

class scaleway.qaas.v1alpha1.types.ListPlatformsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BACKEND_NAME_ASC = 'backend_name_asc'

BACKEND_NAME_DESC = 'backend_name_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

PROVIDER_NAME_ASC = 'provider_name_asc'

PROVIDER_NAME_DESC = 'provider_name_desc'

TECHNOLOGY_ASC = 'technology_asc'

TECHNOLOGY_DESC = 'technology_desc'

TYPE_ASC = 'type_asc'

TYPE_DESC = 'type_desc'

class scaleway.qaas.v1alpha1.types.ListPlatformsResponse(total_count: 'int', platforms: 'List[Platform]')

Bases: object

platforms: List[Platform]

List of platforms.

total_count: int

Total number of platforms.

class scaleway.qaas.v1alpha1.types.ListProcessResultsRequest(process_id: 'str', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListProcessResultsRequestOrderBy]')

Bases: object

order_by: Optional[ListProcessResultsRequestOrderBy]

Sort order of the returned results.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of results to return per page.

process_id: str

ID of the process.

class scaleway.qaas.v1alpha1.types.ListProcessResultsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.qaas.v1alpha1.types.ListProcessResultsResponse(total_count: 'int', process_results: 'List[ProcessResult]')

Bases: object

process_results: List[ProcessResult]

List of results.

total_count: int

Total number of results.

class scaleway.qaas.v1alpha1.types.ListProcessesRequest(application_id: 'Optional[str]', tags: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListProcessesRequestOrderBy]', project_id: 'Optional[str]')

Bases: object

application_id: Optional[str]

List processes that have been created for this application.

order_by: Optional[ListProcessesRequestOrderBy]

Sort order of the returned processes.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of processes to return per page.

project_id: Optional[str]

List processes belonging to this project ID.

tags: Optional[List[str]]

List processes with these tags.

class scaleway.qaas.v1alpha1.types.ListProcessesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STARTED_AT_ASC = 'started_at_asc'

STARTED_AT_DESC = 'started_at_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.qaas.v1alpha1.types.ListProcessesResponse(total_count: 'int', processes: 'List[Process]')

Bases: object

processes: List[Process]

List of processes.

total_count: int

Total number of processes.

class scaleway.qaas.v1alpha1.types.ListSessionACLsRequest(session_id: 'str', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListSessionACLsRequestOrderBy]')

Bases: object

order_by: Optional[ListSessionACLsRequestOrderBy]

page: Optional[int]

page_size: Optional[int]

session_id: str

class scaleway.qaas.v1alpha1.types.ListSessionACLsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACCESS_ASC = 'access_asc'

ACCESS_DESC = 'access_desc'

class scaleway.qaas.v1alpha1.types.ListSessionACLsResponse(total_count: 'int', acls: 'List[SessionAccess]')

Bases: object

acls: List[SessionAccess]

total_count: int

class scaleway.qaas.v1alpha1.types.ListSessionsRequest(platform_id: 'Optional[str]', tags: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListSessionsRequestOrderBy]', project_id: 'Optional[str]')

Bases: object

order_by: Optional[ListSessionsRequestOrderBy]

Sort order of the returned sessions.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of sessions to return per page.

platform_id: Optional[str]

List sessions that have been created for this platform.

project_id: Optional[str]

List sessions belonging to this project ID.

tags: Optional[List[str]]

List sessions with these tags.

class scaleway.qaas.v1alpha1.types.ListSessionsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STARTED_AT_ASC = 'started_at_asc'

STARTED_AT_DESC = 'started_at_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.qaas.v1alpha1.types.ListSessionsResponse(total_count: 'int', sessions: 'List[Session]')

Bases: object

sessions: List[Session]

List of sessions.

total_count: int

Total number of sessions.

class scaleway.qaas.v1alpha1.types.Platform(id: 'str', version: 'str', name: 'str', provider_name: 'str', backend_name: 'str', type_: 'PlatformType', technology: 'PlatformTechnology', max_qubit_count: 'int', availability: 'PlatformAvailability', metadata: 'str', price_per_hour: 'Optional[Money]', hardware: 'Optional[PlatformHardware]')

Bases: object

availability: PlatformAvailability

Availability of the platform.

backend_name: str

Name of the running backend over the platform (ascella, qsim, aer…).

hardware: Optional[PlatformHardware]

Specifications of the underlying hardware.

id: str

Unique ID of the platform.

max_qubit_count: int

Estimated maximum number of qubits supported by the platform.

metadata: str

Metadata provided by the platform.

name: str

Name of the platform.

price_per_hour: Optional[Money]

Price to be payed per hour (excluding free tiers).

provider_name: str

Provider name of the platform.

technology: PlatformTechnology

Technology used by the platform.

type_: PlatformType

Type of the platform.

version: str

Verison of the platform.

class scaleway.qaas.v1alpha1.types.PlatformAvailability(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

SCARCE = 'scarce'

SHORTAGE = 'shortage'

UNKNOWN_AVAILABILITY = 'unknown_availability'

class scaleway.qaas.v1alpha1.types.PlatformHardware(name: 'str', vcpus: 'int', gpus: 'int', gpus_network: 'str', ram: 'int', vram: 'int')

Bases: object

gpus: int

Number of GPUs available (0 if no GPU).

gpus_network: str

Network topology of GPUs (PCIe, NVLink…).

name: str

Product name of the hardware.

ram: int

Amount of RAM available in byte.

vcpus: int

Number of vCPUs available.

vram: int

Amount of VRAM available in byte (0 if no GPU).

class scaleway.qaas.v1alpha1.types.PlatformTechnology(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

GENERAL_PURPOSE = 'general_purpose'

PHOTONIC = 'photonic'

UNKNOWN_TECHNOLOGY = 'unknown_technology'

class scaleway.qaas.v1alpha1.types.PlatformType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

QPU = 'qpu'

SIMULATOR = 'simulator'

UNKNOWN_TYPE = 'unknown_type'

class scaleway.qaas.v1alpha1.types.Process(id: 'str', name: 'str', attached_session_ids: 'List[str]', application_id: 'Optional[str]', status: 'ProcessStatus', project_id: 'str', tags: 'List[str]', platform_id: 'Optional[str]', created_at: 'Optional[datetime]', started_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', finished_at: 'Optional[datetime]', progress: 'Optional[int]', progress_message: 'Optional[str]', input: 'Optional[str]')

Bases: object

application_id: Optional[str]

Application ID for which the process has been created.

attached_session_ids: List[str]

List of sessions generated by the process.

created_at: Optional[datetime]

Tme at which the process was created.

finished_at: Optional[datetime]

Time at which the process was finished.

id: str

Unique ID of the process.

input: Optional[str]

Input payload of the process as JSON string.

name: str

Name of the process.

platform_id: Optional[str]

Platform ID for which the process has been created.

progress: Optional[int]

Progress of the process, from 0 to 1.

progress_message: Optional[str]

Any progress of the process.

project_id: str

Project ID in which the process has been created.

started_at: Optional[datetime]

Time at which the process started.

status: ProcessStatus

Status of the process.

tags: List[str]

Tags of the process.

updated_at: Optional[datetime]

Time at which the process was updated.

class scaleway.qaas.v1alpha1.types.ProcessResult(process_id: 'str', result: 'str', created_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation time of the result.

process_id: str

ID of the parent process.

result: str

Result in JSON format.

class scaleway.qaas.v1alpha1.types.ProcessStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CANCELLED = 'cancelled'

CANCELLING = 'cancelling'

COMPLETED = 'completed'

ERROR = 'error'

RUNNING = 'running'

STARTING = 'starting'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.qaas.v1alpha1.types.Session(id: 'str', name: 'str', platform_id: 'str', waiting_job_count: 'int', created_at: 'Optional[datetime]', finished_job_count: 'int', status: 'SessionStatus', project_id: 'str', deduplication_id: 'str', origin_type: 'SessionOriginType', started_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', terminated_at: 'Optional[datetime]', max_idle_duration: 'Optional[str]', max_duration: 'Optional[str]', tags: 'Optional[List[str]]', origin_id: 'Optional[str]', progress_message: 'Optional[str]')

Bases: object

created_at: Optional[datetime]

The time at which the session was created.

deduplication_id: str

Deduplication ID of the session.

finished_job_count: int

Number of finished jobs linked to the session.

id: str

Unique ID of the session.

max_duration: Optional[str]

Maximum duration before the session ends.

max_idle_duration: Optional[str]

Maximum idle time before the session ends.

name: str

Name of the session.

origin_id: Optional[str]

Unique ID of the session’s origin resource (if exists).

origin_type: SessionOriginType

Resource type that creates the session.

platform_id: str

Platform ID for which the session has been created.

progress_message: Optional[str]

Any progress of the session.

project_id: str

Project ID in which the session has been created.

started_at: Optional[datetime]

The time at which the session started.

status: SessionStatus

Status of the session.

tags: Optional[List[str]]

Tags of the session.

terminated_at: Optional[datetime]

The time at which the session was terminated.

updated_at: Optional[datetime]

The time at which the session was updated.

waiting_job_count: int

Number of waiting jobs linked to the session.

class scaleway.qaas.v1alpha1.types.SessionAccess(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

FULL = 'full'

READ_JOB = 'read_job'

READ_JOB_CIRCUIT = 'read_job_circuit'

READ_JOB_RESULT = 'read_job_result'

READ_SESSION = 'read_session'

READ_WRITE_JOB = 'read_write_job'

READ_WRITE_SESSION = 'read_write_session'

UNKNOWN_ACCESS = 'unknown_access'

class scaleway.qaas.v1alpha1.types.SessionOriginType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CUSTOMER = 'customer'

PROCESS = 'process'

UNKNOWN_ORIGIN_TYPE = 'unknown_origin_type'

class scaleway.qaas.v1alpha1.types.SessionStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

RUNNING = 'running'

STARTING = 'starting'

STOPPED = 'stopped'

STOPPING = 'stopping'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.qaas.v1alpha1.types.TerminateSessionRequest(session_id: 'str')

Bases: object

session_id: str

Unique ID of the session.

class scaleway.qaas.v1alpha1.types.UpdateJobRequest(job_id: 'str', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

job_id: str

Unique ID of the job.

name: Optional[str]

Name of the job.

tags: Optional[List[str]]

Tags of the job.

class scaleway.qaas.v1alpha1.types.UpdateProcessRequest(process_id: 'str', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

name: Optional[str]

Name of the process.

process_id: str

Unique ID of the process.

tags: Optional[List[str]]

Tags of the process.

class scaleway.qaas.v1alpha1.types.UpdateSessionRequest(session_id: 'str', name: 'Optional[str]', max_idle_duration: 'Optional[str]', max_duration: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

max_duration: Optional[str]

Maximum time before the session ends.

max_idle_duration: Optional[str]

Maximum idle duration before the session ends.

name: Optional[str]

Name of the session.

session_id: str

Unique ID of the session.

tags: Optional[List[str]]

Tags of the session.

Module contents

class scaleway.qaas.v1alpha1.Application(id: 'str', name: 'str', type_: 'ApplicationType', compatible_platform_ids: 'List[str]', input_template: 'str')

Bases: object

compatible_platform_ids: List[str]

List of compatible platform (by IDs) able to run this application.

id: str

Unique ID of the application.

input_template: str

JSON format describing the expected input.

name: str

Name of the application.

type_: ApplicationType

Type of the application.

class scaleway.qaas.v1alpha1.ApplicationType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

UNKNOWN_TYPE = 'unknown_type'

VQE = 'vqe'

class scaleway.qaas.v1alpha1.CancelJobRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job.

class scaleway.qaas.v1alpha1.CancelProcessRequest(process_id: 'str')

Bases: object

process_id: str

Unique ID of the process.

class scaleway.qaas.v1alpha1.CreateJobRequest(name: 'str', session_id: 'str', circuit: 'JobCircuit', tags: 'Optional[List[str]]', max_duration: 'Optional[str]')

Bases: object

circuit: JobCircuit

Quantum circuit that should be executed.

max_duration: Optional[str]

Maximum duration of the job.

name: str

Name of the job.

session_id: str

Session in which the job is executed.

tags: Optional[List[str]]

Tags of the job.

class scaleway.qaas.v1alpha1.CreateProcessRequest(name: 'str', project_id: 'Optional[str]', platform_id: 'Optional[str]', application_id: 'Optional[str]', input: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

application_id: Optional[str]

ID of the application for which the process was created.

input: Optional[str]

Process parameters in JSON format.

name: str

Name of the process.

platform_id: Optional[str]

ID of the platform for which the process was created.

project_id: Optional[str]

ID of the project in which the process was created.

tags: Optional[List[str]]

Tags of the process.

class scaleway.qaas.v1alpha1.CreateSessionRequest(platform_id: 'str', project_id: 'Optional[str]', name: 'Optional[str]', max_idle_duration: 'Optional[str]', max_duration: 'Optional[str]', tags: 'Optional[List[str]]', deduplication_id: 'Optional[str]')

Bases: object

deduplication_id: Optional[str]

Deduplication ID of the session.

max_duration: Optional[str]

Maximum duration before the session ends.

max_idle_duration: Optional[str]

Maximum idle duration before the session ends.

name: Optional[str]

Name of the session.

platform_id: str

ID of the Platform for which the session was created.

project_id: Optional[str]

ID of the Project in which the session was created.

tags: Optional[List[str]]

Tags of the session.

class scaleway.qaas.v1alpha1.DeleteJobRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job.

class scaleway.qaas.v1alpha1.DeleteProcessRequest(process_id: 'str')

Bases: object

process_id: str

Unique ID of the process.

class scaleway.qaas.v1alpha1.DeleteSessionRequest(session_id: 'str')

Bases: object

session_id: str

Unique ID of the session.

class scaleway.qaas.v1alpha1.GetApplicationRequest(application_id: 'str')

Bases: object

application_id: str

Unique ID of the application.

class scaleway.qaas.v1alpha1.GetJobCircuitRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job.

class scaleway.qaas.v1alpha1.GetJobRequest(job_id: 'str')

Bases: object

job_id: str

Unique ID of the job you want to get.

class scaleway.qaas.v1alpha1.GetPlatformRequest(platform_id: 'str')

Bases: object

platform_id: str

Unique ID of the platform.

class scaleway.qaas.v1alpha1.GetProcessRequest(process_id: 'str')

Bases: object

process_id: str

Unique ID of the process.

class scaleway.qaas.v1alpha1.GetSessionRequest(session_id: 'str')

Bases: object

session_id: str

Unique ID of the session.

class scaleway.qaas.v1alpha1.Job(id: 'str', name: 'str', session_id: 'str', status: 'JobStatus', tags: 'Optional[List[str]]', created_at: 'Optional[datetime]', started_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', progress_message: 'Optional[str]', job_duration: 'Optional[str]', result_distribution: 'Optional[str]')

Bases: object

created_at: Optional[datetime]

Time at which the job was created.

id: str

Unique ID of the job.

job_duration: Optional[str]

Duration of the job, if the job is finished.

name: str

Job name.

progress_message: Optional[str]

Last progress message, if the job has started.

result_distribution: Optional[str]

Result of the job, if the job is finished.

session_id: str

Session ID in which the job is executed.

started_at: Optional[datetime]

Time at which the job was started.

status: JobStatus

Job status.

tags: Optional[List[str]]

Tags of the job.

updated_at: Optional[datetime]

Time at which the job was updated.

class scaleway.qaas.v1alpha1.JobCircuit(perceval_circuit: 'Optional[str]', qiskit_circuit: 'Optional[str]')

Bases: object

perceval_circuit: Optional[str]

qiskit_circuit: Optional[str]

class scaleway.qaas.v1alpha1.JobResult(job_id: 'str', result: 'Optional[str]', url: 'Optional[str]', created_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation time of the result.

job_id: str

ID of the parent job.

result: Optional[str]

Result in JSON format.

url: Optional[str]

URL to download a large result (optional).

class scaleway.qaas.v1alpha1.JobStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CANCELLED = 'cancelled'

CANCELLING = 'cancelling'

COMPLETED = 'completed'

ERROR = 'error'

RUNNING = 'running'

UNKNOWN_STATUS = 'unknown_status'

WAITING = 'waiting'

class scaleway.qaas.v1alpha1.ListApplicationsRequest(name: 'Optional[str]', application_type: 'Optional[ApplicationType]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListApplicationsRequestOrderBy]')

Bases: object

application_type: Optional[ApplicationType]

List applications with this type.

name: Optional[str]

List applications with this name.

order_by: Optional[ListApplicationsRequestOrderBy]

Sort order of the returned applications.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of applications a to return per page.

class scaleway.qaas.v1alpha1.ListApplicationsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

TYPE_ASC = 'type_asc'

TYPE_DESC = 'type_desc'

class scaleway.qaas.v1alpha1.ListApplicationsResponse(total_count: 'int', applications: 'List[Application]')

Bases: object

applications: List[Application]

List of applications.

total_count: int

Total number of applications.

class scaleway.qaas.v1alpha1.ListJobResultsRequest(job_id: 'str', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListJobResultsRequestOrderBy]')

Bases: object

job_id: str

ID of the job.

order_by: Optional[ListJobResultsRequestOrderBy]

Sort order of the returned results.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of results to return per page.

class scaleway.qaas.v1alpha1.ListJobResultsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.qaas.v1alpha1.ListJobResultsResponse(total_count: 'int', job_results: 'List[JobResult]')

Bases: object

job_results: List[JobResult]

List of results.

total_count: int

Total number of results.

class scaleway.qaas.v1alpha1.ListJobsRequest(tags: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListJobsRequestOrderBy]', session_id: 'Optional[str]', project_id: 'Optional[str]')

Bases: object

order_by: Optional[ListJobsRequestOrderBy]

Sort order of the returned jobs.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of jobs to return per page.

project_id: Optional[str]

session_id: Optional[str]

tags: Optional[List[str]]

List jobs with these tags.

class scaleway.qaas.v1alpha1.ListJobsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

PLATFORM_NAME_ASC = 'platform_name_asc'

PLATFORM_NAME_DESC = 'platform_name_desc'

SESSION_NAME_ASC = 'session_name_asc'

SESSION_NAME_DESC = 'session_name_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.qaas.v1alpha1.ListJobsResponse(total_count: 'int', jobs: 'List[Job]')

Bases: object

jobs: List[Job]

List of jobs.

total_count: int

Total number of jobs.

class scaleway.qaas.v1alpha1.ListPlatformsRequest(provider_name: 'Optional[str]', backend_name: 'Optional[str]', name: 'Optional[str]', platform_type: 'Optional[PlatformType]', platform_technology: 'Optional[PlatformTechnology]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListPlatformsRequestOrderBy]')

Bases: object

backend_name: Optional[str]

List platforms with this backend name.

name: Optional[str]

List platforms with this name.

order_by: Optional[ListPlatformsRequestOrderBy]

Sort order of the returned platforms.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of platforms to return per page.

platform_technology: Optional[PlatformTechnology]

List platforms with this technology.

platform_type: Optional[PlatformType]

List platforms with this type.

provider_name: Optional[str]

List platforms with this provider name.

class scaleway.qaas.v1alpha1.ListPlatformsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BACKEND_NAME_ASC = 'backend_name_asc'

BACKEND_NAME_DESC = 'backend_name_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

PROVIDER_NAME_ASC = 'provider_name_asc'

PROVIDER_NAME_DESC = 'provider_name_desc'

TECHNOLOGY_ASC = 'technology_asc'

TECHNOLOGY_DESC = 'technology_desc'

TYPE_ASC = 'type_asc'

TYPE_DESC = 'type_desc'

class scaleway.qaas.v1alpha1.ListPlatformsResponse(total_count: 'int', platforms: 'List[Platform]')

Bases: object

platforms: List[Platform]

List of platforms.

total_count: int

Total number of platforms.

class scaleway.qaas.v1alpha1.ListProcessResultsRequest(process_id: 'str', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListProcessResultsRequestOrderBy]')

Bases: object

order_by: Optional[ListProcessResultsRequestOrderBy]

Sort order of the returned results.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of results to return per page.

process_id: str

ID of the process.

class scaleway.qaas.v1alpha1.ListProcessResultsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.qaas.v1alpha1.ListProcessResultsResponse(total_count: 'int', process_results: 'List[ProcessResult]')

Bases: object

process_results: List[ProcessResult]

List of results.

total_count: int

Total number of results.

class scaleway.qaas.v1alpha1.ListProcessesRequest(application_id: 'Optional[str]', tags: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListProcessesRequestOrderBy]', project_id: 'Optional[str]')

Bases: object

application_id: Optional[str]

List processes that have been created for this application.

order_by: Optional[ListProcessesRequestOrderBy]

Sort order of the returned processes.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of processes to return per page.

project_id: Optional[str]

List processes belonging to this project ID.

tags: Optional[List[str]]

List processes with these tags.

class scaleway.qaas.v1alpha1.ListProcessesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STARTED_AT_ASC = 'started_at_asc'

STARTED_AT_DESC = 'started_at_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.qaas.v1alpha1.ListProcessesResponse(total_count: 'int', processes: 'List[Process]')

Bases: object

processes: List[Process]

List of processes.

total_count: int

Total number of processes.

class scaleway.qaas.v1alpha1.ListSessionACLsRequest(session_id: 'str', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListSessionACLsRequestOrderBy]')

Bases: object

order_by: Optional[ListSessionACLsRequestOrderBy]

page: Optional[int]

page_size: Optional[int]

session_id: str

class scaleway.qaas.v1alpha1.ListSessionACLsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACCESS_ASC = 'access_asc'

ACCESS_DESC = 'access_desc'

class scaleway.qaas.v1alpha1.ListSessionACLsResponse(total_count: 'int', acls: 'List[SessionAccess]')

Bases: object

acls: List[SessionAccess]

total_count: int

class scaleway.qaas.v1alpha1.ListSessionsRequest(platform_id: 'Optional[str]', tags: 'Optional[List[str]]', page: 'Optional[int]', page_size: 'Optional[int]', order_by: 'Optional[ListSessionsRequestOrderBy]', project_id: 'Optional[str]')

Bases: object

order_by: Optional[ListSessionsRequestOrderBy]

Sort order of the returned sessions.

page: Optional[int]

Page number.

page_size: Optional[int]

Maximum number of sessions to return per page.

platform_id: Optional[str]

List sessions that have been created for this platform.

project_id: Optional[str]

List sessions belonging to this project ID.

tags: Optional[List[str]]

List sessions with these tags.

class scaleway.qaas.v1alpha1.ListSessionsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STARTED_AT_ASC = 'started_at_asc'

STARTED_AT_DESC = 'started_at_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.qaas.v1alpha1.ListSessionsResponse(total_count: 'int', sessions: 'List[Session]')

Bases: object

sessions: List[Session]

List of sessions.

total_count: int

Total number of sessions.

class scaleway.qaas.v1alpha1.Platform(id: 'str', version: 'str', name: 'str', provider_name: 'str', backend_name: 'str', type_: 'PlatformType', technology: 'PlatformTechnology', max_qubit_count: 'int', availability: 'PlatformAvailability', metadata: 'str', price_per_hour: 'Optional[Money]', hardware: 'Optional[PlatformHardware]')

Bases: object

availability: PlatformAvailability

Availability of the platform.

backend_name: str

Name of the running backend over the platform (ascella, qsim, aer…).

hardware: Optional[PlatformHardware]

Specifications of the underlying hardware.

id: str

Unique ID of the platform.

max_qubit_count: int

Estimated maximum number of qubits supported by the platform.

metadata: str

Metadata provided by the platform.

name: str

Name of the platform.

price_per_hour: Optional[Money]

Price to be payed per hour (excluding free tiers).

provider_name: str

Provider name of the platform.

technology: PlatformTechnology

Technology used by the platform.

type_: PlatformType

Type of the platform.

version: str

Verison of the platform.

class scaleway.qaas.v1alpha1.PlatformAvailability(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

SCARCE = 'scarce'

SHORTAGE = 'shortage'

UNKNOWN_AVAILABILITY = 'unknown_availability'

class scaleway.qaas.v1alpha1.PlatformHardware(name: 'str', vcpus: 'int', gpus: 'int', gpus_network: 'str', ram: 'int', vram: 'int')

Bases: object

gpus: int

Number of GPUs available (0 if no GPU).

gpus_network: str

Network topology of GPUs (PCIe, NVLink…).

name: str

Product name of the hardware.

ram: int

Amount of RAM available in byte.

vcpus: int

Number of vCPUs available.

vram: int

Amount of VRAM available in byte (0 if no GPU).

class scaleway.qaas.v1alpha1.PlatformTechnology(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

GENERAL_PURPOSE = 'general_purpose'

PHOTONIC = 'photonic'

UNKNOWN_TECHNOLOGY = 'unknown_technology'

class scaleway.qaas.v1alpha1.PlatformType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

QPU = 'qpu'

SIMULATOR = 'simulator'

UNKNOWN_TYPE = 'unknown_type'

class scaleway.qaas.v1alpha1.Process(id: 'str', name: 'str', attached_session_ids: 'List[str]', application_id: 'Optional[str]', status: 'ProcessStatus', project_id: 'str', tags: 'List[str]', platform_id: 'Optional[str]', created_at: 'Optional[datetime]', started_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', finished_at: 'Optional[datetime]', progress: 'Optional[int]', progress_message: 'Optional[str]', input: 'Optional[str]')

Bases: object

application_id: Optional[str]

Application ID for which the process has been created.

attached_session_ids: List[str]

List of sessions generated by the process.

created_at: Optional[datetime]

Tme at which the process was created.

finished_at: Optional[datetime]

Time at which the process was finished.

id: str

Unique ID of the process.

input: Optional[str]

Input payload of the process as JSON string.

name: str

Name of the process.

platform_id: Optional[str]

Platform ID for which the process has been created.

progress: Optional[int]

Progress of the process, from 0 to 1.

progress_message: Optional[str]

Any progress of the process.

project_id: str

Project ID in which the process has been created.

started_at: Optional[datetime]

Time at which the process started.

status: ProcessStatus

Status of the process.

tags: List[str]

Tags of the process.

updated_at: Optional[datetime]

Time at which the process was updated.

class scaleway.qaas.v1alpha1.ProcessResult(process_id: 'str', result: 'str', created_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation time of the result.

process_id: str

ID of the parent process.

result: str

Result in JSON format.

class scaleway.qaas.v1alpha1.ProcessStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CANCELLED = 'cancelled'

CANCELLING = 'cancelling'

COMPLETED = 'completed'

ERROR = 'error'

RUNNING = 'running'

STARTING = 'starting'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.qaas.v1alpha1.QaasV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage Scaleway Quantum as a Service.

cancel_job(*, job_id: str) → Job

Cancel a job. Cancel the job corresponding to the provided job ID. :param job_id: Unique ID of the job. :return: Job

Usage:

result = api.cancel_job(
    job_id="example",
)

cancel_process(*, process_id: str) → Process

Cancel a running process. Cancel a process by its unique ID. Intermediate results are still available. :param process_id: Unique ID of the process. :return: Process

Usage:

result = api.cancel_process(
    process_id="example",
)

create_job(*, name: str, session_id: str, circuit: JobCircuit, tags: Optional[List[str]] = None, max_duration: Optional[str] = None) → Job

Create a job. Create a job to be executed inside a session. :param name: Name of the job. :param session_id: Session in which the job is executed. :param circuit: Quantum circuit that should be executed. :param tags: Tags of the job. :param max_duration: Maximum duration of the job. :return: Job

Usage:

result = api.create_job(
    name="example",
    session_id="example",
    circuit=JobCircuit(),
)

create_process(*, name: str, project_id: Optional[str] = None, platform_id: Optional[str] = None, application_id: Optional[str] = None, input: Optional[str] = None, tags: Optional[List[str]] = None) → Process

Create a process. Create a new process for the specified application on a specified platform. :param name: Name of the process. :param project_id: ID of the project in which the process was created. :param platform_id: ID of the platform for which the process was created. :param application_id: ID of the application for which the process was created. :param input: Process parameters in JSON format. :param tags: Tags of the process. :return: Process

Usage:

result = api.create_process(
    name="example",
)

create_session(*, platform_id: str, project_id: Optional[str] = None, name: Optional[str] = None, max_idle_duration: Optional[str] = None, max_duration: Optional[str] = None, tags: Optional[List[str]] = None, deduplication_id: Optional[str] = None) → Session

Create a session. Create a dedicated session for the specified platform. :param platform_id: ID of the Platform for which the session was created. :param project_id: ID of the Project in which the session was created. :param name: Name of the session. :param max_idle_duration: Maximum idle duration before the session ends. :param max_duration: Maximum duration before the session ends. :param tags: Tags of the session. :param deduplication_id: Deduplication ID of the session. :return: Session

Usage:

result = api.create_session(
    platform_id="example",
)

delete_job(*, job_id: str) → None

Delete a job. Delete the job corresponding to the provided job ID. :param job_id: Unique ID of the job.

Usage:

result = api.delete_job(
    job_id="example",
)

delete_process(*, process_id: str) → None

Delete an existing process. Delete a process by its unique ID and delete all its data. :param process_id: Unique ID of the process.

Usage:

result = api.delete_process(
    process_id="example",
)

delete_session(*, session_id: str) → None

Delete an existing session. Delete a session by its unique ID and delete all its attached jobs. :param session_id: Unique ID of the session.

Usage:

result = api.delete_session(
    session_id="example",
)

get_application(*, application_id: str) → Application

Get application information. Retrieve information about the provided applcation ID, such as name, type and compatible platforms. :param application_id: Unique ID of the application. :return: Application

Usage:

result = api.get_application(
    application_id="example",
)

get_job(*, job_id: str) → Job

Get job information. Retrieve information about the provided job ID, such as status, payload, and result. :param job_id: Unique ID of the job you want to get. :return: Job

Usage:

result = api.get_job(
    job_id="example",
)

get_job_circuit(*, job_id: str) → JobCircuit

Get a job circuit. Retrieve the circuit of the provided job ID. :param job_id: Unique ID of the job. :return: JobCircuit

Usage:

result = api.get_job_circuit(
    job_id="example",
)

get_platform(*, platform_id: str) → Platform

Get platform information. Retrieve information about the provided platform ID, such as provider name, technology, and type. :param platform_id: Unique ID of the platform. :return: Platform

Usage:

result = api.get_platform(
    platform_id="example",
)

get_process(*, process_id: str) → Process

Get process infrormation. Retrieve information about the provided process ID, such as name, status and progress. :param process_id: Unique ID of the process. :return: Process

Usage:

result = api.get_process(
    process_id="example",
)

get_session(*, session_id: str) → Session

Get session infrormation. Retrieve information about the provided session ID, such as name, status, and number of executed jobs. :param session_id: Unique ID of the session. :return: Session

Usage:

result = api.get_session(
    session_id="example",
)

list_applications(*, name: Optional[str] = None, application_type: Optional[ApplicationType] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListApplicationsRequestOrderBy] = None) → ListApplicationsResponse

List all available applications. Retrieve information about all applications. :param name: List applications with this name. :param application_type: List applications with this type. :param page: Page number. :param page_size: Maximum number of applications a to return per page. :param order_by: Sort order of the returned applications. :return: ListApplicationsResponse

Usage:

result = api.list_applications()

list_applications_all(*, name: Optional[str] = None, application_type: Optional[ApplicationType] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListApplicationsRequestOrderBy] = None) → List[Application]

List all available applications. Retrieve information about all applications. :param name: List applications with this name. :param application_type: List applications with this type. :param page: Page number. :param page_size: Maximum number of applications a to return per page. :param order_by: Sort order of the returned applications. :return: List[Application]

Usage:

result = api.list_applications_all()

list_job_results(*, job_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobResultsRequestOrderBy] = None) → ListJobResultsResponse

List all results of a job. Retrieve all intermediate and final results of a job. :param job_id: ID of the job. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: ListJobResultsResponse

Usage:

result = api.list_job_results(
    job_id="example",
)

list_job_results_all(*, job_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobResultsRequestOrderBy] = None) → List[JobResult]

List all results of a job. Retrieve all intermediate and final results of a job. :param job_id: ID of the job. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: List[JobResult]

Usage:

result = api.list_job_results_all(
    job_id="example",
)

list_jobs(*, session_id: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobsRequestOrderBy] = None) → ListJobsResponse

List all jobs within a project or session. Retrieve information about all jobs within a given project or session. :param session_id: List jobs with this session ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param project_id: List jobs with this project ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param tags: List jobs with these tags. :param page: Page number. :param page_size: Maximum number of jobs to return per page. :param order_by: Sort order of the returned jobs. :return: ListJobsResponse

Usage:

result = api.list_jobs()

list_jobs_all(*, session_id: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListJobsRequestOrderBy] = None) → List[Job]

List all jobs within a project or session. Retrieve information about all jobs within a given project or session. :param session_id: List jobs with this session ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param project_id: List jobs with this project ID. One-Of (‘resource_id’): at most one of ‘session_id’, ‘project_id’ could be set. :param tags: List jobs with these tags. :param page: Page number. :param page_size: Maximum number of jobs to return per page. :param order_by: Sort order of the returned jobs. :return: List[Job]

Usage:

result = api.list_jobs_all()

list_platforms(*, provider_name: Optional[str] = None, backend_name: Optional[str] = None, name: Optional[str] = None, platform_type: Optional[PlatformType] = None, platform_technology: Optional[PlatformTechnology] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListPlatformsRequestOrderBy] = None) → ListPlatformsResponse

List all available platforms. Retrieve information about all platforms. :param provider_name: List platforms with this provider name. :param backend_name: List platforms with this backend name. :param name: List platforms with this name. :param platform_type: List platforms with this type. :param platform_technology: List platforms with this technology. :param page: Page number. :param page_size: Maximum number of platforms to return per page. :param order_by: Sort order of the returned platforms. :return: ListPlatformsResponse

Usage:

result = api.list_platforms()

list_platforms_all(*, provider_name: Optional[str] = None, backend_name: Optional[str] = None, name: Optional[str] = None, platform_type: Optional[PlatformType] = None, platform_technology: Optional[PlatformTechnology] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListPlatformsRequestOrderBy] = None) → List[Platform]

List all available platforms. Retrieve information about all platforms. :param provider_name: List platforms with this provider name. :param backend_name: List platforms with this backend name. :param name: List platforms with this name. :param platform_type: List platforms with this type. :param platform_technology: List platforms with this technology. :param page: Page number. :param page_size: Maximum number of platforms to return per page. :param order_by: Sort order of the returned platforms. :return: List[Platform]

Usage:

result = api.list_platforms_all()

list_process_results(*, process_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessResultsRequestOrderBy] = None) → ListProcessResultsResponse

List all results of a process. Retrieve all intermediate and final result of a process. :param process_id: ID of the process. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: ListProcessResultsResponse

Usage:

result = api.list_process_results(
    process_id="example",
)

list_process_results_all(*, process_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessResultsRequestOrderBy] = None) → List[ProcessResult]

List all results of a process. Retrieve all intermediate and final result of a process. :param process_id: ID of the process. :param page: Page number. :param page_size: Maximum number of results to return per page. :param order_by: Sort order of the returned results. :return: List[ProcessResult]

Usage:

result = api.list_process_results_all(
    process_id="example",
)

list_processes(*, application_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessesRequestOrderBy] = None, project_id: Optional[str] = None) → ListProcessesResponse

List all processes. Retrieve information about all processes. :param application_id: List processes that have been created for this application. :param tags: List processes with these tags. :param page: Page number. :param page_size: Maximum number of processes to return per page. :param order_by: Sort order of the returned processes. :param project_id: List processes belonging to this project ID. :return: ListProcessesResponse

Usage:

result = api.list_processes()

list_processes_all(*, application_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListProcessesRequestOrderBy] = None, project_id: Optional[str] = None) → List[Process]

List all processes. Retrieve information about all processes. :param application_id: List processes that have been created for this application. :param tags: List processes with these tags. :param page: Page number. :param page_size: Maximum number of processes to return per page. :param order_by: Sort order of the returned processes. :param project_id: List processes belonging to this project ID. :return: List[Process]

Usage:

result = api.list_processes_all()

list_session_ac_ls(*, session_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionACLsRequestOrderBy] = None) → ListSessionACLsResponse

Parameters:

• session_id –

• page –

• page_size –

• order_by –

Returns:

ListSessionACLsResponse

Usage:

result = api.list_session_ac_ls(
    session_id="example",
)

list_session_ac_ls_all(*, session_id: str, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionACLsRequestOrderBy] = None) → List[SessionAccess]

Parameters:

• session_id –

• page –

• page_size –

• order_by –

Returns:

List[SessionAccess]

Usage:

result = api.list_session_ac_ls_all(
    session_id="example",
)

list_sessions(*, platform_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionsRequestOrderBy] = None, project_id: Optional[str] = None) → ListSessionsResponse

List all sessions. Retrieve information about all sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. :param page_size: Maximum number of sessions to return per page. :param order_by: Sort order of the returned sessions. :param project_id: List sessions belonging to this project ID. :return: ListSessionsResponse

Usage:

result = api.list_sessions()

list_sessions_all(*, platform_id: Optional[str] = None, tags: Optional[List[str]] = None, page: Optional[int] = None, page_size: Optional[int] = None, order_by: Optional[ListSessionsRequestOrderBy] = None, project_id: Optional[str] = None) → List[Session]

List all sessions. Retrieve information about all sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. :param page_size: Maximum number of sessions to return per page. :param order_by: Sort order of the returned sessions. :param project_id: List sessions belonging to this project ID. :return: List[Session]

Usage:

result = api.list_sessions_all()

terminate_session(*, session_id: str) → Session

Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs. :param session_id: Unique ID of the session. :return: Session

Usage:

result = api.terminate_session(
    session_id="example",
)

update_job(*, job_id: str, name: Optional[str] = None, tags: Optional[List[str]] = None) → Job

Update job information. Update job information about the provided job ID. :param job_id: Unique ID of the job. :param name: Name of the job. :param tags: Tags of the job. :return: Job

Usage:

result = api.update_job(
    job_id="example",
)

update_process(*, process_id: str, name: Optional[str] = None, tags: Optional[List[str]] = None) → Process

Update process information. Update process information of the provided process ID. :param process_id: Unique ID of the process. :param name: Name of the process. :param tags: Tags of the process. :return: Process

Usage:

result = api.update_process(
    process_id="example",
)

update_session(*, session_id: str, name: Optional[str] = None, max_idle_duration: Optional[str] = None, max_duration: Optional[str] = None, tags: Optional[List[str]] = None) → Session

Update session information. Update session information of the provided session ID. :param session_id: Unique ID of the session. :param name: Name of the session. :param max_idle_duration: Maximum idle duration before the session ends. :param max_duration: Maximum time before the session ends. :param tags: Tags of the session. :return: Session

Usage:

result = api.update_session(
    session_id="example",
)

wait_for_job(*, job_id: str, options: Optional[WaitForOptions[Job, bool]] = None) → Job

Get job information. Retrieve information about the provided job ID, such as status, payload, and result. :param job_id: Unique ID of the job you want to get. :return: Job

Usage:

result = api.get_job(
    job_id="example",
)

wait_for_process(*, process_id: str, options: Optional[WaitForOptions[Process, bool]] = None) → Process

Get process infrormation. Retrieve information about the provided process ID, such as name, status and progress. :param process_id: Unique ID of the process. :return: Process

Usage:

result = api.get_process(
    process_id="example",
)

wait_for_session(*, session_id: str, options: Optional[WaitForOptions[Session, bool]] = None) → Session

Get session infrormation. Retrieve information about the provided session ID, such as name, status, and number of executed jobs. :param session_id: Unique ID of the session. :return: Session

Usage:

result = api.get_session(
    session_id="example",
)

class scaleway.qaas.v1alpha1.Session(id: 'str', name: 'str', platform_id: 'str', waiting_job_count: 'int', created_at: 'Optional[datetime]', finished_job_count: 'int', status: 'SessionStatus', project_id: 'str', deduplication_id: 'str', origin_type: 'SessionOriginType', started_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', terminated_at: 'Optional[datetime]', max_idle_duration: 'Optional[str]', max_duration: 'Optional[str]', tags: 'Optional[List[str]]', origin_id: 'Optional[str]', progress_message: 'Optional[str]')

Bases: object

created_at: Optional[datetime]

The time at which the session was created.

deduplication_id: str

Deduplication ID of the session.

finished_job_count: int

Number of finished jobs linked to the session.

id: str

Unique ID of the session.

max_duration: Optional[str]

Maximum duration before the session ends.

max_idle_duration: Optional[str]

Maximum idle time before the session ends.

name: str

Name of the session.

origin_id: Optional[str]

Unique ID of the session’s origin resource (if exists).

origin_type: SessionOriginType

Resource type that creates the session.

platform_id: str

Platform ID for which the session has been created.

progress_message: Optional[str]

Any progress of the session.

project_id: str

Project ID in which the session has been created.

started_at: Optional[datetime]

The time at which the session started.

status: SessionStatus

Status of the session.

tags: Optional[List[str]]

Tags of the session.

terminated_at: Optional[datetime]

The time at which the session was terminated.

updated_at: Optional[datetime]

The time at which the session was updated.

waiting_job_count: int

Number of waiting jobs linked to the session.

class scaleway.qaas.v1alpha1.SessionAccess(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

FULL = 'full'

READ_JOB = 'read_job'

READ_JOB_CIRCUIT = 'read_job_circuit'

READ_JOB_RESULT = 'read_job_result'

READ_SESSION = 'read_session'

READ_WRITE_JOB = 'read_write_job'

READ_WRITE_SESSION = 'read_write_session'

UNKNOWN_ACCESS = 'unknown_access'

class scaleway.qaas.v1alpha1.SessionOriginType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CUSTOMER = 'customer'

PROCESS = 'process'

UNKNOWN_ORIGIN_TYPE = 'unknown_origin_type'

class scaleway.qaas.v1alpha1.SessionStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

RUNNING = 'running'

STARTING = 'starting'

STOPPED = 'stopped'

STOPPING = 'stopping'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.qaas.v1alpha1.TerminateSessionRequest(session_id: 'str')

Bases: object

session_id: str

Unique ID of the session.

class scaleway.qaas.v1alpha1.UpdateJobRequest(job_id: 'str', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

job_id: str

Unique ID of the job.

name: Optional[str]

Name of the job.

tags: Optional[List[str]]

Tags of the job.

class scaleway.qaas.v1alpha1.UpdateProcessRequest(process_id: 'str', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

name: Optional[str]

Name of the process.

process_id: str

Unique ID of the process.

tags: Optional[List[str]]

Tags of the process.

class scaleway.qaas.v1alpha1.UpdateSessionRequest(session_id: 'str', name: 'Optional[str]', max_idle_duration: 'Optional[str]', max_duration: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

max_duration: Optional[str]

Maximum time before the session ends.

max_idle_duration: Optional[str]

Maximum idle duration before the session ends.

name: Optional[str]

Name of the session.

session_id: str

Unique ID of the session.

tags: Optional[List[str]]

Tags of the session.