qaas

package
v1.0.0-beta.35 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 15, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package qaas provides methods and message types of the qaas v1alpha1 API.

Index

Constants

View Source 
const (
	ApplicationTypeUnknownType = ApplicationType("unknown_type")
	// Variational Quantum Eigensolver is a type hybrid algorithm to find the ground state of a given physical system.
	ApplicationTypeVqe = ApplicationType("vqe")
)
View Source 
const (
	BookingStatusUnknownStatus = BookingStatus("unknown_status")
	BookingStatusWaiting       = BookingStatus("waiting")
	BookingStatusValidating    = BookingStatus("validating")
	BookingStatusValidated     = BookingStatus("validated")
	BookingStatusCancelling    = BookingStatus("cancelling")
	BookingStatusCancelled     = BookingStatus("cancelled")
	BookingStatusError         = BookingStatus("error")
)
View Source 
const (
	JobStatusUnknownStatus = JobStatus("unknown_status")
	JobStatusWaiting       = JobStatus("waiting")
	JobStatusError         = JobStatus("error")
	JobStatusRunning       = JobStatus("running")
	JobStatusCompleted     = JobStatus("completed")
	JobStatusCancelling    = JobStatus("cancelling")
	JobStatusCancelled     = JobStatus("cancelled")
)
View Source 
const (
	ListApplicationsRequestOrderByNameAsc  = ListApplicationsRequestOrderBy("name_asc")
	ListApplicationsRequestOrderByNameDesc = ListApplicationsRequestOrderBy("name_desc")
	ListApplicationsRequestOrderByTypeAsc  = ListApplicationsRequestOrderBy("type_asc")
	ListApplicationsRequestOrderByTypeDesc = ListApplicationsRequestOrderBy("type_desc")
)
View Source 
const (
	ListBookingsRequestOrderByCreatedAtDesc = ListBookingsRequestOrderBy("created_at_desc")
	ListBookingsRequestOrderByCreatedAtAsc  = ListBookingsRequestOrderBy("created_at_asc")
	ListBookingsRequestOrderByStartedAtDesc = ListBookingsRequestOrderBy("started_at_desc")
	ListBookingsRequestOrderByStartedAtAsc  = ListBookingsRequestOrderBy("started_at_asc")
)
View Source 
const (
	ListJobResultsRequestOrderByCreatedAtDesc = ListJobResultsRequestOrderBy("created_at_desc")
	ListJobResultsRequestOrderByCreatedAtAsc  = ListJobResultsRequestOrderBy("created_at_asc")
)
View Source 
const (
	ListJobsRequestOrderByCreatedAtDesc    = ListJobsRequestOrderBy("created_at_desc")
	ListJobsRequestOrderByCreatedAtAsc     = ListJobsRequestOrderBy("created_at_asc")
	ListJobsRequestOrderByStatusAsc        = ListJobsRequestOrderBy("status_asc")
	ListJobsRequestOrderByStatusDesc       = ListJobsRequestOrderBy("status_desc")
	ListJobsRequestOrderByPlatformNameAsc  = ListJobsRequestOrderBy("platform_name_asc")
	ListJobsRequestOrderByPlatformNameDesc = ListJobsRequestOrderBy("platform_name_desc")
	ListJobsRequestOrderByNameAsc          = ListJobsRequestOrderBy("name_asc")
	ListJobsRequestOrderByNameDesc         = ListJobsRequestOrderBy("name_desc")
	ListJobsRequestOrderBySessionNameAsc   = ListJobsRequestOrderBy("session_name_asc")
	ListJobsRequestOrderBySessionNameDesc  = ListJobsRequestOrderBy("session_name_desc")
)
View Source 
const (
	ListModelsRequestOrderByCreatedAtDesc = ListModelsRequestOrderBy("created_at_desc")
	ListModelsRequestOrderByCreatedAtAsc  = ListModelsRequestOrderBy("created_at_asc")
)
View Source 
const (
	ListPlatformsRequestOrderByNameAsc          = ListPlatformsRequestOrderBy("name_asc")
	ListPlatformsRequestOrderByNameDesc         = ListPlatformsRequestOrderBy("name_desc")
	ListPlatformsRequestOrderByProviderNameAsc  = ListPlatformsRequestOrderBy("provider_name_asc")
	ListPlatformsRequestOrderByProviderNameDesc = ListPlatformsRequestOrderBy("provider_name_desc")
	ListPlatformsRequestOrderByTypeAsc          = ListPlatformsRequestOrderBy("type_asc")
	ListPlatformsRequestOrderByTypeDesc         = ListPlatformsRequestOrderBy("type_desc")
	ListPlatformsRequestOrderByTechnologyAsc    = ListPlatformsRequestOrderBy("technology_asc")
	ListPlatformsRequestOrderByTechnologyDesc   = ListPlatformsRequestOrderBy("technology_desc")
	ListPlatformsRequestOrderByBackendNameAsc   = ListPlatformsRequestOrderBy("backend_name_asc")
	ListPlatformsRequestOrderByBackendNameDesc  = ListPlatformsRequestOrderBy("backend_name_desc")
)
View Source 
const (
	ListProcessResultsRequestOrderByCreatedAtDesc = ListProcessResultsRequestOrderBy("created_at_desc")
	ListProcessResultsRequestOrderByCreatedAtAsc  = ListProcessResultsRequestOrderBy("created_at_asc")
)
View Source 
const (
	ListProcessesRequestOrderByCreatedAtDesc = ListProcessesRequestOrderBy("created_at_desc")
	ListProcessesRequestOrderByCreatedAtAsc  = ListProcessesRequestOrderBy("created_at_asc")
	ListProcessesRequestOrderByNameAsc       = ListProcessesRequestOrderBy("name_asc")
	ListProcessesRequestOrderByNameDesc      = ListProcessesRequestOrderBy("name_desc")
	ListProcessesRequestOrderByStartedAtAsc  = ListProcessesRequestOrderBy("started_at_asc")
	ListProcessesRequestOrderByStartedAtDesc = ListProcessesRequestOrderBy("started_at_desc")
	ListProcessesRequestOrderByStatusAsc     = ListProcessesRequestOrderBy("status_asc")
	ListProcessesRequestOrderByStatusDesc    = ListProcessesRequestOrderBy("status_desc")
)
View Source 
const (
	ListSessionACLsRequestOrderByAccessAsc  = ListSessionACLsRequestOrderBy("access_asc")
	ListSessionACLsRequestOrderByAccessDesc = ListSessionACLsRequestOrderBy("access_desc")
)
View Source 
const (
	ListSessionsRequestOrderByNameAsc       = ListSessionsRequestOrderBy("name_asc")
	ListSessionsRequestOrderByNameDesc      = ListSessionsRequestOrderBy("name_desc")
	ListSessionsRequestOrderByStartedAtAsc  = ListSessionsRequestOrderBy("started_at_asc")
	ListSessionsRequestOrderByStartedAtDesc = ListSessionsRequestOrderBy("started_at_desc")
	ListSessionsRequestOrderByStatusAsc     = ListSessionsRequestOrderBy("status_asc")
	ListSessionsRequestOrderByStatusDesc    = ListSessionsRequestOrderBy("status_desc")
	ListSessionsRequestOrderByCreatedAtDesc = ListSessionsRequestOrderBy("created_at_desc")
	ListSessionsRequestOrderByCreatedAtAsc  = ListSessionsRequestOrderBy("created_at_asc")
)
View Source 
const (
	PlatformAvailabilityUnknownAvailability = PlatformAvailability("unknown_availability")
	PlatformAvailabilityAvailable           = PlatformAvailability("available")
	PlatformAvailabilityShortage            = PlatformAvailability("shortage")
	PlatformAvailabilityScarce              = PlatformAvailability("scarce")
	PlatformAvailabilityMaintenance         = PlatformAvailability("maintenance")
)
View Source 
const (
	PlatformTechnologyUnknownTechnology = PlatformTechnology("unknown_technology")
	PlatformTechnologyPhotonic          = PlatformTechnology("photonic")
	PlatformTechnologyGeneralPurpose    = PlatformTechnology("general_purpose")
	PlatformTechnologyTrappedIon        = PlatformTechnology("trapped_ion")
	PlatformTechnologySuperconducting   = PlatformTechnology("superconducting")
	PlatformTechnologyNeutralAtom       = PlatformTechnology("neutral_atom")
)
View Source 
const (
	PlatformTypeUnknownType = PlatformType("unknown_type")
	PlatformTypeSimulator   = PlatformType("simulator")
	PlatformTypeQpu         = PlatformType("qpu")
)
View Source 
const (
	ProcessStatusUnknownStatus = ProcessStatus("unknown_status")
	ProcessStatusError         = ProcessStatus("error")
	ProcessStatusStarting      = ProcessStatus("starting")
	ProcessStatusRunning       = ProcessStatus("running")
	ProcessStatusCompleted     = ProcessStatus("completed")
	ProcessStatusCancelling    = ProcessStatus("cancelling")
	ProcessStatusCancelled     = ProcessStatus("cancelled")
)
View Source 
const (
	SessionAccessUnknownAccess    = SessionAccess("unknown_access")
	SessionAccessFull             = SessionAccess("full")
	SessionAccessReadSession      = SessionAccess("read_session")
	SessionAccessReadWriteSession = SessionAccess("read_write_session")
	SessionAccessReadJobResult    = SessionAccess("read_job_result")
	SessionAccessReadJobCircuit   = SessionAccess("read_job_circuit")
	SessionAccessReadJob          = SessionAccess("read_job")
	SessionAccessReadWriteJob     = SessionAccess("read_write_job")
)
View Source 
const (
	SessionOriginTypeUnknownOriginType = SessionOriginType("unknown_origin_type")
	SessionOriginTypeCustomer          = SessionOriginType("customer")
	SessionOriginTypeProcess           = SessionOriginType("process")
)
View Source 
const (
	SessionStatusUnknownStatus = SessionStatus("unknown_status")
	SessionStatusRunning       = SessionStatus("running")
	SessionStatusStopped       = SessionStatus("stopped")
	SessionStatusStarting      = SessionStatus("starting")
	SessionStatusStopping      = SessionStatus("stopping")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

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

func NewAPI 

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) CancelJob 

func (s *API) CancelJob(req *CancelJobRequest, opts ...scw.RequestOption) (*Job, error)

CancelJob: Cancel the job corresponding to the provided **job ID**.

func (*API) CancelProcess 

func (s *API) CancelProcess(req *CancelProcessRequest, opts ...scw.RequestOption) (*Process, error)

CancelProcess: Cancel a process by its unique ID. Intermediate results are still available.

func (*API) CreateJob 

func (s *API) CreateJob(req *CreateJobRequest, opts ...scw.RequestOption) (*Job, error)

CreateJob: Create a job to be executed inside a session.

func (*API) CreateModel 

func (s *API) CreateModel(req *CreateModelRequest, opts ...scw.RequestOption) (*Model, error)

CreateModel: Create and register a new model that can be executed through next jobs. A model can also be assigned to a Session.

func (*API) CreateProcess 

func (s *API) CreateProcess(req *CreateProcessRequest, opts ...scw.RequestOption) (*Process, error)

CreateProcess: Create a new process for the specified application on a specified platform.

func (*API) CreateSession 

func (s *API) CreateSession(req *CreateSessionRequest, opts ...scw.RequestOption) (*Session, error)

CreateSession: Create a dedicated session for the specified platform.

func (*API) DeleteJob 

func (s *API) DeleteJob(req *DeleteJobRequest, opts ...scw.RequestOption) error

DeleteJob: Delete the job corresponding to the provided **job ID**.

func (*API) DeleteProcess 

func (s *API) DeleteProcess(req *DeleteProcessRequest, opts ...scw.RequestOption) error

DeleteProcess: Delete a process by its unique ID and delete all its data.

func (*API) DeleteSession 

func (s *API) DeleteSession(req *DeleteSessionRequest, opts ...scw.RequestOption) error

DeleteSession: Delete a session by its unique ID and delete all its attached job and booking.

func (*API) GetApplication 

func (s *API) GetApplication(req *GetApplicationRequest, opts ...scw.RequestOption) (*Application, error)

GetApplication: Retrieve information about the provided **applcation ID**, such as name, type and compatible platforms.

func (*API) GetBooking 

func (s *API) GetBooking(req *GetBookingRequest, opts ...scw.RequestOption) (*Booking, error)

GetBooking: Retrieve information about the provided **booking ID**, such as description, status and progress message.

func (*API) GetJob 

func (s *API) GetJob(req *GetJobRequest, opts ...scw.RequestOption) (*Job, error)

GetJob: Retrieve information about the provided **job ID**, such as status, payload, and result.

func (*API) GetJobCircuit 

func (s *API) GetJobCircuit(req *GetJobCircuitRequest, opts ...scw.RequestOption) (*JobCircuit, error)

GetJobCircuit: Retrieve the circuit of the provided **job ID**.

func (*API) GetModel 

func (s *API) GetModel(req *GetModelRequest, opts ...scw.RequestOption) (*Model, error)

GetModel: Retrieve information about of the provided **model ID**.

func (*API) GetPlatform 

func (s *API) GetPlatform(req *GetPlatformRequest, opts ...scw.RequestOption) (*Platform, error)

GetPlatform: Retrieve information about the provided **platform ID**, such as provider name, technology, and type.

func (*API) GetProcess 

func (s *API) GetProcess(req *GetProcessRequest, opts ...scw.RequestOption) (*Process, error)

GetProcess: Retrieve information about the provided **process ID**, such as name, status and progress.

func (*API) GetSession 

func (s *API) GetSession(req *GetSessionRequest, opts ...scw.RequestOption) (*Session, error)

GetSession: Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs.

func (*API) ListApplications 

func (s *API) ListApplications(req *ListApplicationsRequest, opts ...scw.RequestOption) (*ListApplicationsResponse, error)

ListApplications: Retrieve information about all applications.

func (*API) ListBookings 

func (s *API) ListBookings(req *ListBookingsRequest, opts ...scw.RequestOption) (*ListBookingsResponse, error)

ListBookings: Retrieve information about all bookings of the provided **project ID** or ** platform ID**.

func (*API) ListJobResults 

func (s *API) ListJobResults(req *ListJobResultsRequest, opts ...scw.RequestOption) (*ListJobResultsResponse, error)

ListJobResults: Retrieve all intermediate and final results of a job.

func (*API) ListJobs 

func (s *API) ListJobs(req *ListJobsRequest, opts ...scw.RequestOption) (*ListJobsResponse, error)

ListJobs: Retrieve information about all jobs within a given project or session.

func (*API) ListModels 

func (s *API) ListModels(req *ListModelsRequest, opts ...scw.RequestOption) (*ListModelsResponse, error)

ListModels: Retrieve information about all models of the provided **project ID**.

func (*API) ListPlatforms 

func (s *API) ListPlatforms(req *ListPlatformsRequest, opts ...scw.RequestOption) (*ListPlatformsResponse, error)

ListPlatforms: Retrieve information about all platforms.

func (*API) ListProcessResults 

func (s *API) ListProcessResults(req *ListProcessResultsRequest, opts ...scw.RequestOption) (*ListProcessResultsResponse, error)

ListProcessResults: Retrieve all intermediate and final result of a process.

func (*API) ListProcesses 

func (s *API) ListProcesses(req *ListProcessesRequest, opts ...scw.RequestOption) (*ListProcessesResponse, error)

ListProcesses: Retrieve information about all processes.

func (*API) ListSessionACLs 

func (s *API) ListSessionACLs(req *ListSessionACLsRequest, opts ...scw.RequestOption) (*ListSessionACLsResponse, error)

ListSessionACLs:

func (*API) ListSessions 

func (s *API) ListSessions(req *ListSessionsRequest, opts ...scw.RequestOption) (*ListSessionsResponse, error)

ListSessions: Retrieve information about all sessions.

func (*API) TerminateSession 

func (s *API) TerminateSession(req *TerminateSessionRequest, opts ...scw.RequestOption) (*Session, error)

TerminateSession: Terminate a session by its unique ID and cancel all its attached jobs and booking.

func (*API) UpdateBooking 

func (s *API) UpdateBooking(req *UpdateBookingRequest, opts ...scw.RequestOption) (*Booking, error)

UpdateBooking: Update booking information of the provided **booking ID**.

func (*API) UpdateJob 

func (s *API) UpdateJob(req *UpdateJobRequest, opts ...scw.RequestOption) (*Job, error)

UpdateJob: Update job information about the provided **job ID**.

func (*API) UpdateProcess 

func (s *API) UpdateProcess(req *UpdateProcessRequest, opts ...scw.RequestOption) (*Process, error)

UpdateProcess: Update process information of the provided **process ID**.

func (*API) UpdateSession 

func (s *API) UpdateSession(req *UpdateSessionRequest, opts ...scw.RequestOption) (*Session, error)

UpdateSession: Update session information of the provided **session ID**.

type Application 

type Application struct {
	// ID: unique ID of the application.
	ID string `json:"id"`

	// Name: name of the application.
	Name string `json:"name"`

	// Type: type of the application.
	// Default value: unknown_type
	Type ApplicationType `json:"type"`

	// CompatiblePlatformIDs: list of compatible platform (by IDs) able to run this application.
	CompatiblePlatformIDs []string `json:"compatible_platform_ids"`

	// InputTemplate: JSON format describing the expected input.
	InputTemplate string `json:"input_template"`
}

Application: application.

type ApplicationType 

type ApplicationType string

func (ApplicationType) MarshalJSON 

func (enum ApplicationType) MarshalJSON() ([]byte, error)

func (ApplicationType) String 

func (enum ApplicationType) String() string

func (*ApplicationType) UnmarshalJSON 

func (enum *ApplicationType) UnmarshalJSON(data []byte) error

func (ApplicationType) Values 

func (enum ApplicationType) Values() []ApplicationType

type Booking 

type Booking struct {
	// ID: unique ID of the booking.
	ID string `json:"id"`

	// CreatedAt: time at which the booking was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: time at which the booking starts.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: time at which the booking was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// FinishedAt: time at which the booking finishes.
	FinishedAt *time.Time `json:"finished_at"`

	// Status: status of the booking.
	// Default value: unknown_status
	Status BookingStatus `json:"status"`

	// Description: description of the booking slot.
	Description string `json:"description"`

	// ProgressMessage: any progress message of the booking.
	ProgressMessage string `json:"progress_message"`
}

Booking: booking.

type BookingStatus 

type BookingStatus string

func (BookingStatus) MarshalJSON 

func (enum BookingStatus) MarshalJSON() ([]byte, error)

func (BookingStatus) String 

func (enum BookingStatus) String() string

func (*BookingStatus) UnmarshalJSON 

func (enum *BookingStatus) UnmarshalJSON(data []byte) error

func (BookingStatus) Values 

func (enum BookingStatus) Values() []BookingStatus

type CancelJobRequest 

type CancelJobRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`
}

CancelJobRequest: cancel job request.

type CancelProcessRequest 

type CancelProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`
}

CancelProcessRequest: cancel process request.

type CreateJobRequest 

type CreateJobRequest struct {
	// Name: name of the job.
	Name string `json:"name"`

	// Tags: tags of the job.
	Tags *[]string `json:"tags,omitempty"`

	// SessionID: session in which the job is executed.
	SessionID string `json:"session_id"`

	// Circuit: quantum circuit that should be executed.
	Circuit *JobCircuit `json:"circuit"`

	// MaxDuration: maximum duration of the job.
	MaxDuration *scw.Duration `json:"max_duration,omitempty"`

	// ModelID: computation model ID to be executed by the job.
	ModelID *string `json:"model_id,omitempty"`

	// Parameters: execution parameters for this job.
	Parameters *string `json:"parameters,omitempty"`
}

CreateJobRequest: create job request.

type CreateModelRequest 

type CreateModelRequest struct {
	// ProjectID: project ID to attach this model.
	ProjectID string `json:"project_id"`

	// Payload: the serialized model data.
	Payload *string `json:"payload,omitempty"`
}

CreateModelRequest: create model request.

type CreateProcessRequest 

type CreateProcessRequest struct {
	// ProjectID: ID of the project in which the process was created.
	ProjectID string `json:"project_id"`

	// PlatformID: ID of the platform for which the process was created.
	PlatformID *string `json:"platform_id,omitempty"`

	// ApplicationID: ID of the application for which the process was created.
	ApplicationID *string `json:"application_id,omitempty"`

	// Name: name of the process.
	Name string `json:"name"`

	// Input: process parameters in JSON format.
	Input *string `json:"input,omitempty"`

	// Tags: tags of the process.
	Tags []string `json:"tags"`
}

CreateProcessRequest: create process request.

type CreateSessionRequest 

type CreateSessionRequest struct {
	// ProjectID: ID of the Project in which the session was created.
	ProjectID string `json:"project_id"`

	// PlatformID: ID of the Platform for which the session was created.
	PlatformID string `json:"platform_id"`

	// Name: name of the session.
	Name *string `json:"name,omitempty"`

	// MaxIDleDuration: maximum idle duration before the session ends.
	MaxIDleDuration *scw.Duration `json:"max_idle_duration,omitempty"`

	// MaxDuration: maximum duration before the session ends.
	MaxDuration *scw.Duration `json:"max_duration,omitempty"`

	// Tags: tags of the session.
	Tags *[]string `json:"tags,omitempty"`

	// DeduplicationID: deduplication ID of the session.
	DeduplicationID *string `json:"deduplication_id,omitempty"`

	// BookingDemand: a booking demand to schedule the session, only applicable if the platform is bookable.
	BookingDemand *CreateSessionRequestBookingDemand `json:"booking_demand,omitempty"`

	// ModelID: default computation model ID to be executed by job assigned to this session.
	ModelID *string `json:"model_id,omitempty"`

	// Parameters: optional platform configuration parameters applied to this session.
	Parameters *string `json:"parameters,omitempty"`
}

CreateSessionRequest: create session request.

type CreateSessionRequestBookingDemand 

type CreateSessionRequestBookingDemand struct {
	StartedAt *time.Time `json:"started_at"`

	FinishedAt *time.Time `json:"finished_at"`

	Description *string `json:"description"`
}

CreateSessionRequestBookingDemand: create session request booking demand.

type DeleteJobRequest 

type DeleteJobRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`
}

DeleteJobRequest: delete job request.

type DeleteProcessRequest 

type DeleteProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`
}

DeleteProcessRequest: delete process request.

type DeleteSessionRequest 

type DeleteSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`
}

DeleteSessionRequest: delete session request.

type GetApplicationRequest 

type GetApplicationRequest struct {
	// ApplicationID: unique ID of the application.
	ApplicationID string `json:"-"`
}

GetApplicationRequest: get application request.

type GetBookingRequest 

type GetBookingRequest struct {
	// BookingID: unique ID of the booking.
	BookingID string `json:"-"`
}

GetBookingRequest: get booking request.

type GetJobCircuitRequest 

type GetJobCircuitRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`
}

GetJobCircuitRequest: get job circuit request.

type GetJobRequest 

type GetJobRequest struct {
	// JobID: unique ID of the job you want to get.
	JobID string `json:"-"`
}

GetJobRequest: get job request.

type GetModelRequest 

type GetModelRequest struct {
	// ModelID: unique ID of the model.
	ModelID string `json:"-"`
}

GetModelRequest: get model request.

type GetPlatformRequest 

type GetPlatformRequest struct {
	// PlatformID: unique ID of the platform.
	PlatformID string `json:"-"`
}

GetPlatformRequest: get platform request.

type GetProcessRequest 

type GetProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`
}

GetProcessRequest: get process request.

type GetSessionRequest 

type GetSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`
}

GetSessionRequest: get session request.

type Job 

type Job struct {
	// ID: unique ID of the job.
	ID string `json:"id"`

	// Name: job name.
	Name string `json:"name"`

	// Tags: tags of the job.
	Tags *[]string `json:"tags"`

	// SessionID: session ID in which the job is executed.
	SessionID string `json:"session_id"`

	// CreatedAt: time at which the job was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: time at which the job was started.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: time at which the job was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// Status: job status.
	// Default value: unknown_status
	Status JobStatus `json:"status"`

	// ProgressMessage: last progress message, if the job has started.
	ProgressMessage *string `json:"progress_message"`

	// JobDuration: duration of the job, if the job is finished.
	JobDuration *scw.Duration `json:"job_duration"`

	// ResultDistribution: result of the job, if the job is finished.
	ResultDistribution *string `json:"result_distribution"`

	// ModelID: computation model ID executed by the job.
	ModelID *string `json:"model_id"`

	// Parameters: execution parameters for this job.
	Parameters *string `json:"parameters"`
}

Job: job.

type JobCircuit 

type JobCircuit struct {
	// PercevalCircuit: circuit generated by Perceval that should be executed.
	// Precisely one of PercevalCircuit, QiskitCircuit must be set.
	PercevalCircuit *string `json:"perceval_circuit,omitempty"`

	// QiskitCircuit: circuit generated by Qiskit that should be executed.
	// Precisely one of PercevalCircuit, QiskitCircuit must be set.
	QiskitCircuit *string `json:"qiskit_circuit,omitempty"`
}

JobCircuit: job circuit.

type JobResult 

type JobResult struct {
	// JobID: ID of the parent job.
	JobID string `json:"job_id"`

	// Result: result in JSON format.
	Result *string `json:"result"`

	// URL: URL to download a large result (optional).
	URL *string `json:"url"`

	// CreatedAt: creation time of the result.
	CreatedAt *time.Time `json:"created_at"`
}

JobResult: job result.

type JobStatus 

type JobStatus string

func (JobStatus) MarshalJSON 

func (enum JobStatus) MarshalJSON() ([]byte, error)

func (JobStatus) String 

func (enum JobStatus) String() string

func (*JobStatus) UnmarshalJSON 

func (enum *JobStatus) UnmarshalJSON(data []byte) error

func (JobStatus) Values 

func (enum JobStatus) Values() []JobStatus

type ListApplicationsRequest 

type ListApplicationsRequest struct {
	// Name: list applications with this name.
	Name *string `json:"-"`

	// ApplicationType: list applications with this type.
	// Default value: unknown_type
	ApplicationType ApplicationType `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of applications a to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned applications.
	// Default value: name_asc
	OrderBy ListApplicationsRequestOrderBy `json:"-"`
}

ListApplicationsRequest: list applications request.

type ListApplicationsRequestOrderBy 

type ListApplicationsRequestOrderBy string

func (ListApplicationsRequestOrderBy) MarshalJSON 

func (enum ListApplicationsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListApplicationsRequestOrderBy) String 

func (enum ListApplicationsRequestOrderBy) String() string

func (*ListApplicationsRequestOrderBy) UnmarshalJSON 

func (enum *ListApplicationsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListApplicationsRequestOrderBy) Values 

func (enum ListApplicationsRequestOrderBy) Values() []ListApplicationsRequestOrderBy

type ListApplicationsResponse 

type ListApplicationsResponse struct {
	// TotalCount: total number of applications.
	TotalCount uint64 `json:"total_count"`

	// Applications: list of applications.
	Applications []*Application `json:"applications"`
}

ListApplicationsResponse: list applications response.

func (*ListApplicationsResponse) UnsafeAppend 

func (r *ListApplicationsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListApplicationsResponse) UnsafeGetTotalCount 

func (r *ListApplicationsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListBookingsRequest 

type ListBookingsRequest struct {
	// ProjectID: list bookings belonging to this project ID.
	ProjectID *string `json:"-"`

	// PlatformID: list bookings attached to this platform ID.
	PlatformID *string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListBookingsRequestOrderBy `json:"-"`
}

ListBookingsRequest: list bookings request.

type ListBookingsRequestOrderBy 

type ListBookingsRequestOrderBy string

func (ListBookingsRequestOrderBy) MarshalJSON 

func (enum ListBookingsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListBookingsRequestOrderBy) String 

func (enum ListBookingsRequestOrderBy) String() string

func (*ListBookingsRequestOrderBy) UnmarshalJSON 

func (enum *ListBookingsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListBookingsRequestOrderBy) Values 

func (enum ListBookingsRequestOrderBy) Values() []ListBookingsRequestOrderBy

type ListBookingsResponse 

type ListBookingsResponse struct {
	// TotalCount: total number of bookings.
	TotalCount uint64 `json:"total_count"`

	// Bookings: list of bookings.
	Bookings []*Booking `json:"bookings"`
}

ListBookingsResponse: list bookings response.

func (*ListBookingsResponse) UnsafeAppend 

func (r *ListBookingsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListBookingsResponse) UnsafeGetTotalCount 

func (r *ListBookingsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListJobResultsRequest 

type ListJobResultsRequest struct {
	// JobID: ID of the job.
	JobID string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListJobResultsRequestOrderBy `json:"-"`
}

ListJobResultsRequest: list job results request.

type ListJobResultsRequestOrderBy 

type ListJobResultsRequestOrderBy string

func (ListJobResultsRequestOrderBy) MarshalJSON 

func (enum ListJobResultsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListJobResultsRequestOrderBy) String 

func (enum ListJobResultsRequestOrderBy) String() string

func (*ListJobResultsRequestOrderBy) UnmarshalJSON 

func (enum *ListJobResultsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListJobResultsRequestOrderBy) Values 

func (enum ListJobResultsRequestOrderBy) Values() []ListJobResultsRequestOrderBy

type ListJobResultsResponse 

type ListJobResultsResponse struct {
	// TotalCount: total number of results.
	TotalCount uint64 `json:"total_count"`

	// JobResults: list of results.
	JobResults []*JobResult `json:"job_results"`
}

ListJobResultsResponse: list job results response.

func (*ListJobResultsResponse) UnsafeAppend 

func (r *ListJobResultsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListJobResultsResponse) UnsafeGetTotalCount 

func (r *ListJobResultsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListJobsRequest 

type ListJobsRequest struct {
	// SessionID: list jobs with this session ID.
	// Precisely one of SessionID, ProjectID must be set.
	SessionID *string `json:"session_id,omitempty"`

	// ProjectID: list jobs with this project ID.
	// Precisely one of SessionID, ProjectID must be set.
	ProjectID *string `json:"project_id,omitempty"`

	// Tags: list jobs with these tags.
	Tags []string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of jobs to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned jobs.
	// Default value: created_at_desc
	OrderBy ListJobsRequestOrderBy `json:"-"`
}

ListJobsRequest: list jobs request.

type ListJobsRequestOrderBy 

type ListJobsRequestOrderBy string

func (ListJobsRequestOrderBy) MarshalJSON 

func (enum ListJobsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListJobsRequestOrderBy) String 

func (enum ListJobsRequestOrderBy) String() string

func (*ListJobsRequestOrderBy) UnmarshalJSON 

func (enum *ListJobsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListJobsRequestOrderBy) Values 

func (enum ListJobsRequestOrderBy) Values() []ListJobsRequestOrderBy

type ListJobsResponse 

type ListJobsResponse struct {
	// TotalCount: total number of jobs.
	TotalCount uint64 `json:"total_count"`

	// Jobs: list of jobs.
	Jobs []*Job `json:"jobs"`
}

ListJobsResponse: list jobs response.

func (*ListJobsResponse) UnsafeAppend 

func (r *ListJobsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListJobsResponse) UnsafeGetTotalCount 

func (r *ListJobsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListModelsRequest 

type ListModelsRequest struct {
	// ProjectID: list models belonging to this project ID.
	ProjectID string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListModelsRequestOrderBy `json:"-"`
}

ListModelsRequest: list models request.

type ListModelsRequestOrderBy 

type ListModelsRequestOrderBy string

func (ListModelsRequestOrderBy) MarshalJSON 

func (enum ListModelsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListModelsRequestOrderBy) String 

func (enum ListModelsRequestOrderBy) String() string

func (*ListModelsRequestOrderBy) UnmarshalJSON 

func (enum *ListModelsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListModelsRequestOrderBy) Values 

func (enum ListModelsRequestOrderBy) Values() []ListModelsRequestOrderBy

type ListModelsResponse 

type ListModelsResponse struct {
	// TotalCount: total number of models.
	TotalCount uint64 `json:"total_count"`

	// Models: list of models.
	Models []*Model `json:"models"`
}

ListModelsResponse: list models response.

func (*ListModelsResponse) UnsafeAppend 

func (r *ListModelsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListModelsResponse) UnsafeGetTotalCount 

func (r *ListModelsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListPlatformsRequest 

type ListPlatformsRequest struct {
	// ProviderName: list platforms with this provider name.
	ProviderName *string `json:"-"`

	// BackendName: list platforms with this backend name.
	BackendName *string `json:"-"`

	// Name: list platforms with this name.
	Name *string `json:"-"`

	// PlatformType: list platforms with this type.
	// Default value: unknown_type
	PlatformType PlatformType `json:"-"`

	// PlatformTechnology: list platforms with this technology.
	// Default value: unknown_technology
	PlatformTechnology PlatformTechnology `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of platforms to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned platforms.
	// Default value: name_asc
	OrderBy ListPlatformsRequestOrderBy `json:"-"`
}

ListPlatformsRequest: list platforms request.

type ListPlatformsRequestOrderBy 

type ListPlatformsRequestOrderBy string

func (ListPlatformsRequestOrderBy) MarshalJSON 

func (enum ListPlatformsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListPlatformsRequestOrderBy) String 

func (enum ListPlatformsRequestOrderBy) String() string

func (*ListPlatformsRequestOrderBy) UnmarshalJSON 

func (enum *ListPlatformsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListPlatformsRequestOrderBy) Values 

func (enum ListPlatformsRequestOrderBy) Values() []ListPlatformsRequestOrderBy

type ListPlatformsResponse 

type ListPlatformsResponse struct {
	// TotalCount: total number of platforms.
	TotalCount uint64 `json:"total_count"`

	// Platforms: list of platforms.
	Platforms []*Platform `json:"platforms"`
}

ListPlatformsResponse: list platforms response.

func (*ListPlatformsResponse) UnsafeAppend 

func (r *ListPlatformsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListPlatformsResponse) UnsafeGetTotalCount 

func (r *ListPlatformsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListProcessResultsRequest 

type ListProcessResultsRequest struct {
	// ProcessID: ID of the process.
	ProcessID string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListProcessResultsRequestOrderBy `json:"-"`
}

ListProcessResultsRequest: list process results request.

type ListProcessResultsRequestOrderBy 

type ListProcessResultsRequestOrderBy string

func (ListProcessResultsRequestOrderBy) MarshalJSON 

func (enum ListProcessResultsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListProcessResultsRequestOrderBy) String 

func (enum ListProcessResultsRequestOrderBy) String() string

func (*ListProcessResultsRequestOrderBy) UnmarshalJSON 

func (enum *ListProcessResultsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListProcessResultsRequestOrderBy) Values 

func (enum ListProcessResultsRequestOrderBy) Values() []ListProcessResultsRequestOrderBy

type ListProcessResultsResponse 

type ListProcessResultsResponse struct {
	// TotalCount: total number of results.
	TotalCount uint64 `json:"total_count"`

	// ProcessResults: list of results.
	ProcessResults []*ProcessResult `json:"process_results"`
}

ListProcessResultsResponse: list process results response.

func (*ListProcessResultsResponse) UnsafeAppend 

func (r *ListProcessResultsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListProcessResultsResponse) UnsafeGetTotalCount 

func (r *ListProcessResultsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListProcessesRequest 

type ListProcessesRequest struct {
	// ApplicationID: list processes that have been created for this application.
	ApplicationID *string `json:"-"`

	// Tags: list processes with these tags.
	Tags []string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of processes to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned processes.
	// Default value: created_at_desc
	OrderBy ListProcessesRequestOrderBy `json:"-"`

	// ProjectID: list processes belonging to this project ID.
	ProjectID string `json:"-"`
}

ListProcessesRequest: list processes request.

type ListProcessesRequestOrderBy 

type ListProcessesRequestOrderBy string

func (ListProcessesRequestOrderBy) MarshalJSON 

func (enum ListProcessesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListProcessesRequestOrderBy) String 

func (enum ListProcessesRequestOrderBy) String() string

func (*ListProcessesRequestOrderBy) UnmarshalJSON 

func (enum *ListProcessesRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListProcessesRequestOrderBy) Values 

func (enum ListProcessesRequestOrderBy) Values() []ListProcessesRequestOrderBy

type ListProcessesResponse 

type ListProcessesResponse struct {
	// TotalCount: total number of processes.
	TotalCount uint64 `json:"total_count"`

	// Processes: list of processes.
	Processes []*Process `json:"processes"`
}

ListProcessesResponse: list processes response.

func (*ListProcessesResponse) UnsafeAppend 

func (r *ListProcessesResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListProcessesResponse) UnsafeGetTotalCount 

func (r *ListProcessesResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListSessionACLsRequest 

type ListSessionACLsRequest struct {
	SessionID string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	// OrderBy: default value: access_asc
	OrderBy ListSessionACLsRequestOrderBy `json:"-"`
}

ListSessionACLsRequest: list session ac ls request.

type ListSessionACLsRequestOrderBy 

type ListSessionACLsRequestOrderBy string

func (ListSessionACLsRequestOrderBy) MarshalJSON 

func (enum ListSessionACLsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListSessionACLsRequestOrderBy) String 

func (enum ListSessionACLsRequestOrderBy) String() string

func (*ListSessionACLsRequestOrderBy) UnmarshalJSON 

func (enum *ListSessionACLsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListSessionACLsRequestOrderBy) Values 

func (enum ListSessionACLsRequestOrderBy) Values() []ListSessionACLsRequestOrderBy

type ListSessionACLsResponse 

type ListSessionACLsResponse struct {
	TotalCount uint64 `json:"total_count"`

	ACLs []SessionAccess `json:"acls"`
}

ListSessionACLsResponse: list session ac ls response.

func (*ListSessionACLsResponse) UnsafeAppend 

func (r *ListSessionACLsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListSessionACLsResponse) UnsafeGetTotalCount 

func (r *ListSessionACLsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListSessionsRequest 

type ListSessionsRequest struct {
	// PlatformID: list sessions that have been created for this platform.
	PlatformID *string `json:"-"`

	// Tags: list sessions with these tags.
	Tags []string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of sessions to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned sessions.
	// Default value: name_asc
	OrderBy ListSessionsRequestOrderBy `json:"-"`

	// ProjectID: list sessions belonging to this project ID.
	ProjectID string `json:"-"`
}

ListSessionsRequest: list sessions request.

type ListSessionsRequestOrderBy 

type ListSessionsRequestOrderBy string

func (ListSessionsRequestOrderBy) MarshalJSON 

func (enum ListSessionsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListSessionsRequestOrderBy) String 

func (enum ListSessionsRequestOrderBy) String() string

func (*ListSessionsRequestOrderBy) UnmarshalJSON 

func (enum *ListSessionsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListSessionsRequestOrderBy) Values 

func (enum ListSessionsRequestOrderBy) Values() []ListSessionsRequestOrderBy

type ListSessionsResponse 

type ListSessionsResponse struct {
	// TotalCount: total number of sessions.
	TotalCount uint64 `json:"total_count"`

	// Sessions: list of sessions.
	Sessions []*Session `json:"sessions"`
}

ListSessionsResponse: list sessions response.

func (*ListSessionsResponse) UnsafeAppend 

func (r *ListSessionsResponse) UnsafeAppend(res any) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListSessionsResponse) UnsafeGetTotalCount 

func (r *ListSessionsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type Model 

type Model struct {
	// ID: unique ID of the model.
	ID string `json:"id"`

	// CreatedAt: time at which the model was created.
	CreatedAt *time.Time `json:"created_at"`

	// URL: storage URL of the model.
	URL *string `json:"url"`

	// ProjectID: project ID in which the model has been created.
	ProjectID string `json:"project_id"`
}

Model: model.

type Platform 

type Platform struct {
	// ID: unique ID of the platform.
	ID string `json:"id"`

	// Version: version of the platform.
	Version string `json:"version"`

	// Name: name of the platform.
	Name string `json:"name"`

	// ProviderName: provider name of the platform.
	ProviderName string `json:"provider_name"`

	// BackendName: name of the running backend over the platform (ascella, qsim, aer...).
	BackendName string `json:"backend_name"`

	// Type: type of the platform.
	// Default value: unknown_type
	Type PlatformType `json:"type"`

	// Technology: technology used by the platform.
	// Default value: unknown_technology
	Technology PlatformTechnology `json:"technology"`

	// MaxQubitCount: estimated maximum number of qubits supported by the platform.
	MaxQubitCount uint32 `json:"max_qubit_count"`

	// MaxShotCount: maximum number of shots during a circuit execution.
	MaxShotCount uint32 `json:"max_shot_count"`

	// MaxCircuitCount: maximum number of circuit that can be executed in one call.
	MaxCircuitCount uint32 `json:"max_circuit_count"`

	// Availability: availability of the platform.
	// Default value: unknown_availability
	Availability PlatformAvailability `json:"availability"`

	// Metadata: metadata provided by the platform.
	Metadata string `json:"metadata"`

	// PricePerHour: price to be paid per hour (excluding free tiers).
	PricePerHour *scw.Money `json:"price_per_hour"`

	// PricePerShot: price to be paid per shot (excluding free tiers).
	PricePerShot *scw.Money `json:"price_per_shot"`

	// PricePerCircuit: price to be paid per circuit setup before its execution (excluding free tiers).
	PricePerCircuit *scw.Money `json:"price_per_circuit"`

	// Hardware: specifications of the underlying hardware.
	Hardware *PlatformHardware `json:"hardware"`

	// BookingRequirement: booking constraints to fit if the platform is bookable.
	BookingRequirement *PlatformBookingRequirement `json:"booking_requirement"`

	// Description: english description of the platform.
	Description string `json:"description"`

	// DocumentationURL: documentation link to external documentation to learn more on this platform.
	DocumentationURL string `json:"documentation_url"`

	// IsBookable: specify if the platform is bookable.
	IsBookable bool `json:"is_bookable"`
}

Platform: platform.

type PlatformAvailability 

type PlatformAvailability string

func (PlatformAvailability) MarshalJSON 

func (enum PlatformAvailability) MarshalJSON() ([]byte, error)

func (PlatformAvailability) String 

func (enum PlatformAvailability) String() string

func (*PlatformAvailability) UnmarshalJSON 

func (enum *PlatformAvailability) UnmarshalJSON(data []byte) error

func (PlatformAvailability) Values 

func (enum PlatformAvailability) Values() []PlatformAvailability

type PlatformBookingRequirement 

type PlatformBookingRequirement struct {
	// MinDuration: minimal duration of any booking based on this platform.
	MinDuration *scw.Duration `json:"min_duration"`

	// MaxDuration: maximal duration of any bookings based on this platform.
	MaxDuration *scw.Duration `json:"max_duration"`

	// MaxCancellationDuration: allowed time to cancel a booking attached to this platform before the beginning of the session.
	MaxCancellationDuration *scw.Duration `json:"max_cancellation_duration"`

	// MaxPlanificationDuration: allowed planification time from now where the platform can be booked in the future.
	MaxPlanificationDuration *scw.Duration `json:"max_planification_duration"`
}

PlatformBookingRequirement: platform booking requirement.

type PlatformHardware 

type PlatformHardware struct {
	// Name: product name of the hardware.
	Name string `json:"name"`

	// Vcpus: number of vCPUs available.
	Vcpus uint32 `json:"vcpus"`

	// Gpus: number of GPUs available (0 if no GPU).
	Gpus uint32 `json:"gpus"`

	// GpusNetwork: network topology of GPUs (PCIe, NVLink...).
	GpusNetwork string `json:"gpus_network"`

	// RAM: amount of RAM available in byte.
	RAM uint64 `json:"ram"`

	// Vram: amount of VRAM available in byte (0 if no GPU).
	Vram uint64 `json:"vram"`
}

PlatformHardware: platform hardware.

type PlatformTechnology 

type PlatformTechnology string

func (PlatformTechnology) MarshalJSON 

func (enum PlatformTechnology) MarshalJSON() ([]byte, error)

func (PlatformTechnology) String 

func (enum PlatformTechnology) String() string

func (*PlatformTechnology) UnmarshalJSON 

func (enum *PlatformTechnology) UnmarshalJSON(data []byte) error

func (PlatformTechnology) Values 

func (enum PlatformTechnology) Values() []PlatformTechnology

type PlatformType 

type PlatformType string

func (PlatformType) MarshalJSON 

func (enum PlatformType) MarshalJSON() ([]byte, error)

func (PlatformType) String 

func (enum PlatformType) String() string

func (*PlatformType) UnmarshalJSON 

func (enum *PlatformType) UnmarshalJSON(data []byte) error

func (PlatformType) Values 

func (enum PlatformType) Values() []PlatformType

type Process 

type Process struct {
	// ID: unique ID of the process.
	ID string `json:"id"`

	// Name: name of the process.
	Name string `json:"name"`

	// ApplicationID: application ID for which the process has been created.
	ApplicationID *string `json:"application_id"`

	// PlatformID: platform ID for which the process has been created.
	PlatformID *string `json:"platform_id"`

	// AttachedSessionIDs: list of sessions generated by the process.
	AttachedSessionIDs []string `json:"attached_session_ids"`

	// CreatedAt: time at which the process was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: time at which the process started.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: time at which the process was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// FinishedAt: time at which the process was finished.
	FinishedAt *time.Time `json:"finished_at"`

	// Status: status of the process.
	// Default value: unknown_status
	Status ProcessStatus `json:"status"`

	// ProjectID: project ID in which the process has been created.
	ProjectID string `json:"project_id"`

	// Tags: tags of the process.
	Tags []string `json:"tags"`

	// Progress: progress of the process, from 0 to 1.
	Progress *uint32 `json:"progress"`

	// ProgressMessage: any progress of the process.
	ProgressMessage *string `json:"progress_message"`

	// Input: input payload of the process as JSON string.
	Input *string `json:"input"`
}

Process: process.

type ProcessResult 

type ProcessResult struct {
	// ProcessID: ID of the parent process.
	ProcessID string `json:"process_id"`

	// Result: result in JSON format.
	Result string `json:"result"`

	// CreatedAt: creation time of the result.
	CreatedAt *time.Time `json:"created_at"`
}

ProcessResult: process result.

type ProcessStatus 

type ProcessStatus string

func (ProcessStatus) MarshalJSON 

func (enum ProcessStatus) MarshalJSON() ([]byte, error)

func (ProcessStatus) String 

func (enum ProcessStatus) String() string

func (*ProcessStatus) UnmarshalJSON 

func (enum *ProcessStatus) UnmarshalJSON(data []byte) error

func (ProcessStatus) Values 

func (enum ProcessStatus) Values() []ProcessStatus

type Session 

type Session struct {
	// ID: unique ID of the session.
	ID string `json:"id"`

	// Name: name of the session.
	Name string `json:"name"`

	// PlatformID: platform ID for which the session has been created.
	PlatformID string `json:"platform_id"`

	// CreatedAt: the time at which the session was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: the time at which the session started.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: the time at which the session was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// TerminatedAt: the time at which the session was terminated.
	TerminatedAt *time.Time `json:"terminated_at"`

	// MaxIDleDuration: maximum idle time before the session ends.
	MaxIDleDuration *scw.Duration `json:"max_idle_duration"`

	// MaxDuration: maximum duration before the session ends.
	MaxDuration *scw.Duration `json:"max_duration"`

	// WaitingJobCount: number of waiting jobs linked to the session.
	WaitingJobCount uint64 `json:"waiting_job_count"`

	// FinishedJobCount: number of finished jobs linked to the session.
	FinishedJobCount uint64 `json:"finished_job_count"`

	// Status: status of the session.
	// Default value: unknown_status
	Status SessionStatus `json:"status"`

	// ProjectID: project ID in which the session has been created.
	ProjectID string `json:"project_id"`

	// Tags: tags of the session.
	Tags *[]string `json:"tags"`

	// DeduplicationID: deduplication ID of the session.
	DeduplicationID string `json:"deduplication_id"`

	// OriginType: resource type that creates the session.
	// Default value: unknown_origin_type
	OriginType SessionOriginType `json:"origin_type"`

	// OriginID: unique ID of the session's origin resource (if exists).
	OriginID *string `json:"origin_id"`

	// ProgressMessage: any progress of the session.
	ProgressMessage *string `json:"progress_message"`

	// BookingID: an optional booking unique ID of an attached booking.
	BookingID *string `json:"booking_id"`

	// ModelID: default computation model ID to be executed by job assigned to this session.
	ModelID *string `json:"model_id"`

	// Parameters: platform configuration parameters applied to this session.
	Parameters *string `json:"parameters"`
}

Session: session.

type SessionAccess 

type SessionAccess string

func (SessionAccess) MarshalJSON 

func (enum SessionAccess) MarshalJSON() ([]byte, error)

func (SessionAccess) String 

func (enum SessionAccess) String() string

func (*SessionAccess) UnmarshalJSON 

func (enum *SessionAccess) UnmarshalJSON(data []byte) error

func (SessionAccess) Values 

func (enum SessionAccess) Values() []SessionAccess

type SessionOriginType 

type SessionOriginType string

func (SessionOriginType) MarshalJSON 

func (enum SessionOriginType) MarshalJSON() ([]byte, error)

func (SessionOriginType) String 

func (enum SessionOriginType) String() string

func (*SessionOriginType) UnmarshalJSON 

func (enum *SessionOriginType) UnmarshalJSON(data []byte) error

func (SessionOriginType) Values 

func (enum SessionOriginType) Values() []SessionOriginType

type SessionStatus 

type SessionStatus string

func (SessionStatus) MarshalJSON 

func (enum SessionStatus) MarshalJSON() ([]byte, error)

func (SessionStatus) String 

func (enum SessionStatus) String() string

func (*SessionStatus) UnmarshalJSON 

func (enum *SessionStatus) UnmarshalJSON(data []byte) error

func (SessionStatus) Values 

func (enum SessionStatus) Values() []SessionStatus

type TerminateSessionRequest 

type TerminateSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`
}

TerminateSessionRequest: terminate session request.

type UpdateBookingRequest 

type UpdateBookingRequest struct {
	// BookingID: unique ID of the booking.
	BookingID string `json:"-"`

	// Description: description of the booking slot.
	Description *string `json:"description,omitempty"`
}

UpdateBookingRequest: update booking request.

type UpdateJobRequest 

type UpdateJobRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`

	// Name: name of the job.
	Name *string `json:"name,omitempty"`

	// Tags: tags of the job.
	Tags *[]string `json:"tags,omitempty"`
}

UpdateJobRequest: update job request.

type UpdateProcessRequest 

type UpdateProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`

	// Name: name of the process.
	Name *string `json:"name,omitempty"`

	// Tags: tags of the process.
	Tags *[]string `json:"tags,omitempty"`
}

UpdateProcessRequest: update process request.

type UpdateSessionRequest 

type UpdateSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`

	// Name: name of the session.
	Name *string `json:"name,omitempty"`

	// MaxIDleDuration: maximum idle duration before the session ends.
	MaxIDleDuration *scw.Duration `json:"max_idle_duration,omitempty"`

	// MaxDuration: maximum time before the session ends.
	MaxDuration *scw.Duration `json:"max_duration,omitempty"`

	// Tags: tags of the session.
	Tags *[]string `json:"tags,omitempty"`
}

UpdateSessionRequest: update session request.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.