UNPKG

@eclipse-theiacloud/common

Version:

Common functionality for Theia Cloud

1,609 lines 49.5 kB
/** * Theia Cloud API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.1.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ActivityTracker */ export interface ActivityTracker { /** * * @type {number} * @memberof ActivityTracker */ 'timeoutAfter'?: number; /** * * @type {number} * @memberof ActivityTracker */ 'notifyAfter'?: number; } /** * * @export * @interface AppDefinition */ export interface AppDefinition { /** * * @type {string} * @memberof AppDefinition */ 'apiVersion'?: string; /** * * @type {string} * @memberof AppDefinition */ 'kind'?: string; /** * * @type {ObjectMeta} * @memberof AppDefinition */ 'metadata'?: ObjectMeta; /** * * @type {AppDefinitionSpec} * @memberof AppDefinition */ 'spec'?: AppDefinitionSpec; /** * * @type {AppDefinitionStatus} * @memberof AppDefinition */ 'status'?: AppDefinitionStatus; /** * * @type {string} * @memberof AppDefinition */ 'singular'?: string; /** * * @type {string} * @memberof AppDefinition */ 'crdName'?: string; /** * * @type {string} * @memberof AppDefinition */ 'scope'?: string; /** * * @type {string} * @memberof AppDefinition */ 'plural'?: string; /** * * @type {boolean} * @memberof AppDefinition */ 'served'?: boolean; /** * * @type {boolean} * @memberof AppDefinition */ 'storage'?: boolean; /** * * @type {boolean} * @memberof AppDefinition */ 'deprecated'?: boolean; /** * * @type {string} * @memberof AppDefinition */ 'deprecationWarning'?: string; } /** * A request to list available app definitions. * @export * @interface AppDefinitionListRequest */ export interface AppDefinitionListRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof AppDefinitionListRequest */ 'appId': string; } /** * * @export * @interface AppDefinitionSpec */ export interface AppDefinitionSpec { /** * * @type {string} * @memberof AppDefinitionSpec */ 'name'?: string; /** * * @type {string} * @memberof AppDefinitionSpec */ 'image'?: string; /** * * @type {string} * @memberof AppDefinitionSpec */ 'imagePullPolicy'?: string; /** * * @type {string} * @memberof AppDefinitionSpec */ 'pullSecret'?: string; /** * * @type {number} * @memberof AppDefinitionSpec */ 'uid'?: number; /** * * @type {number} * @memberof AppDefinitionSpec */ 'port'?: number; /** * * @type {string} * @memberof AppDefinitionSpec */ 'ingressname'?: string; /** * * @type {number} * @memberof AppDefinitionSpec */ 'minInstances'?: number; /** * * @type {number} * @memberof AppDefinitionSpec */ 'maxInstances'?: number; /** * * @type {number} * @memberof AppDefinitionSpec */ 'timeout'?: number; /** * * @type {string} * @memberof AppDefinitionSpec */ 'requestsMemory'?: string; /** * * @type {string} * @memberof AppDefinitionSpec */ 'requestsCpu'?: string; /** * * @type {string} * @memberof AppDefinitionSpec */ 'limitsMemory'?: string; /** * * @type {string} * @memberof AppDefinitionSpec */ 'limitsCpu'?: string; /** * * @type {number} * @memberof AppDefinitionSpec */ 'downlinkLimit'?: number; /** * * @type {number} * @memberof AppDefinitionSpec */ 'uplinkLimit'?: number; /** * * @type {string} * @memberof AppDefinitionSpec */ 'mountPath'?: string; /** * * @type {Monitor} * @memberof AppDefinitionSpec */ 'monitor'?: Monitor; /** * * @type {{ [key: string]: string; }} * @memberof AppDefinitionSpec */ 'options'?: { [key: string]: string; }; /** * * @type {Array<string>} * @memberof AppDefinitionSpec */ 'ingressHostnamePrefixes'?: Array<string>; } /** * * @export * @interface AppDefinitionStatus */ export interface AppDefinitionStatus { /** * * @type {string} * @memberof AppDefinitionStatus */ 'operatorStatus'?: string; /** * * @type {string} * @memberof AppDefinitionStatus */ 'operatorMessage'?: string; } /** * * @export * @interface AppDefinitionUpdateRequest */ export interface AppDefinitionUpdateRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof AppDefinitionUpdateRequest */ 'appId': string; /** * The minimum number of instances to run. * @type {number} * @memberof AppDefinitionUpdateRequest */ 'minInstances'?: number; /** * The maximum number of instances to run. * @type {number} * @memberof AppDefinitionUpdateRequest */ 'maxInstances'?: number; } /** * An object to hold all the ways environment variables can be passed. Not to be used by itself. * @export * @interface EnvironmentVars */ export interface EnvironmentVars { /** * Map of environment variables to be passed to Deployment. Ignored if Theia applications are started eagerly. Empty by default. * @type {{ [key: string]: string; }} * @memberof EnvironmentVars */ 'fromMap'?: { [key: string]: string; }; /** * List of ConfigMaps (by name) containing environment variables to be passed to Deployment as envFrom.configMapRef. Ignored if Theia applications are started eagerly. Empty by default. * @type {Array<string>} * @memberof EnvironmentVars */ 'fromConfigMaps'?: Array<string>; /** * List of Secrets (by name) containing environment variables to be passed to Deployment as envFrom.secretRef. Ignored if Theia applications are started eagerly. Empty by default. * @type {Array<string>} * @memberof EnvironmentVars */ 'fromSecrets'?: Array<string>; } /** * A request to launch a new session. * @export * @interface LaunchRequest */ export interface LaunchRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof LaunchRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof LaunchRequest */ 'user': string; /** * The app to launch. Needs to be set if a new or ephemeral session should be launched. For an existing workspace the last app definition will be used if none is given. * @type {string} * @memberof LaunchRequest */ 'appDefinition'?: string; /** * The name of the workspace to mount/create. Needs to be set if an existing workspace should be launched. * @type {string} * @memberof LaunchRequest */ 'workspaceName'?: string; /** * The label of the workspace to mount/create. If no label is given, a default label will be generated. * @type {string} * @memberof LaunchRequest */ 'label'?: string; /** * If true no workspace will be created for the session. * @type {boolean} * @memberof LaunchRequest */ 'ephemeral'?: boolean; /** * Number of minutes to wait for session launch. Default is 3 Minutes. * @type {number} * @memberof LaunchRequest */ 'timeout'?: number; /** * Environment variables * @type {EnvironmentVars} * @memberof LaunchRequest */ 'env'?: EnvironmentVars; } /** * * @export * @interface ManagedFieldsEntry */ export interface ManagedFieldsEntry { /** * * @type {string} * @memberof ManagedFieldsEntry */ 'apiVersion'?: string; /** * * @type {string} * @memberof ManagedFieldsEntry */ 'fieldsType'?: string; /** * * @type {object} * @memberof ManagedFieldsEntry */ 'fieldsV1'?: object; /** * * @type {string} * @memberof ManagedFieldsEntry */ 'manager'?: string; /** * * @type {string} * @memberof ManagedFieldsEntry */ 'operation'?: string; /** * * @type {string} * @memberof ManagedFieldsEntry */ 'subresource'?: string; /** * * @type {string} * @memberof ManagedFieldsEntry */ 'time'?: string; } /** * * @export * @interface Monitor */ export interface Monitor { /** * * @type {number} * @memberof Monitor */ 'port'?: number; /** * * @type {ActivityTracker} * @memberof Monitor */ 'activityTracker'?: ActivityTracker; } /** * * @export * @interface ObjectMeta */ export interface ObjectMeta { /** * * @type {{ [key: string]: string; }} * @memberof ObjectMeta */ 'annotations'?: { [key: string]: string; }; /** * * @type {string} * @memberof ObjectMeta */ 'creationTimestamp'?: string; /** * * @type {number} * @memberof ObjectMeta */ 'deletionGracePeriodSeconds'?: number; /** * * @type {string} * @memberof ObjectMeta */ 'deletionTimestamp'?: string; /** * * @type {Array<string>} * @memberof ObjectMeta */ 'finalizers'?: Array<string>; /** * * @type {string} * @memberof ObjectMeta */ 'generateName'?: string; /** * * @type {number} * @memberof ObjectMeta */ 'generation'?: number; /** * * @type {{ [key: string]: string; }} * @memberof ObjectMeta */ 'labels'?: { [key: string]: string; }; /** * * @type {Array<ManagedFieldsEntry>} * @memberof ObjectMeta */ 'managedFields'?: Array<ManagedFieldsEntry>; /** * * @type {string} * @memberof ObjectMeta */ 'name'?: string; /** * * @type {string} * @memberof ObjectMeta */ 'namespace'?: string; /** * * @type {Array<OwnerReference>} * @memberof ObjectMeta */ 'ownerReferences'?: Array<OwnerReference>; /** * * @type {string} * @memberof ObjectMeta */ 'resourceVersion'?: string; /** * * @type {string} * @memberof ObjectMeta */ 'selfLink'?: string; /** * * @type {string} * @memberof ObjectMeta */ 'uid'?: string; } /** * * @export * @interface OwnerReference */ export interface OwnerReference { /** * * @type {string} * @memberof OwnerReference */ 'apiVersion'?: string; /** * * @type {string} * @memberof OwnerReference */ 'kind'?: string; /** * * @type {boolean} * @memberof OwnerReference */ 'blockOwnerDeletion'?: boolean; /** * * @type {boolean} * @memberof OwnerReference */ 'controller'?: boolean; /** * * @type {string} * @memberof OwnerReference */ 'name'?: string; /** * * @type {string} * @memberof OwnerReference */ 'uid'?: string; } /** * Request to ping the availability of the service. * @export * @interface PingRequest */ export interface PingRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof PingRequest */ 'appId': string; } /** * A request to report activity for a running session. * @export * @interface SessionActivityRequest */ export interface SessionActivityRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof SessionActivityRequest */ 'appId': string; /** * The name of the session for which activity is reported. * @type {string} * @memberof SessionActivityRequest */ 'sessionName': string; } /** * A request to list the sessions of a user. * @export * @interface SessionListRequest */ export interface SessionListRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof SessionListRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof SessionListRequest */ 'user': string; } /** * Description of the performance of a session * @export * @interface SessionPerformance */ export interface SessionPerformance { /** * Used CPU amount of the workspace * @type {string} * @memberof SessionPerformance */ 'cpuAmount': string; /** * Used CPU format of the workspace * @type {string} * @memberof SessionPerformance */ 'cpuFormat': string; /** * Used memory amount of the workspace * @type {string} * @memberof SessionPerformance */ 'memoryAmount': string; /** * Used memory format of the workspace * @type {string} * @memberof SessionPerformance */ 'memoryFormat': string; } /** * A request to list the sessions of a user. * @export * @interface SessionPerformanceRequest */ export interface SessionPerformanceRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof SessionPerformanceRequest */ 'appId': string; /** * The name of the session * @type {string} * @memberof SessionPerformanceRequest */ 'sessionName': string; } /** * * @export * @interface SessionSetConfigValueRequest */ export interface SessionSetConfigValueRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof SessionSetConfigValueRequest */ 'appId': string; /** * The configuration key * @type {string} * @memberof SessionSetConfigValueRequest */ 'key': string; /** * The configuration value * @type {string} * @memberof SessionSetConfigValueRequest */ 'value': string | null; } /** * * @export * @interface SessionSpec */ export interface SessionSpec { /** * * @type {string} * @memberof SessionSpec */ 'name'?: string; /** * * @type {string} * @memberof SessionSpec */ 'appDefinition'?: string; /** * * @type {string} * @memberof SessionSpec */ 'user'?: string; /** * * @type {string} * @memberof SessionSpec */ 'workspace'?: string; /** * * @type {string} * @memberof SessionSpec */ 'sessionSecret'?: string; /** * * @type {{ [key: string]: string; }} * @memberof SessionSpec */ 'options'?: { [key: string]: string; }; /** * * @type {{ [key: string]: string; }} * @memberof SessionSpec */ 'envVars'?: { [key: string]: string; }; /** * * @type {Array<string>} * @memberof SessionSpec */ 'envVarsFromConfigMaps'?: Array<string>; /** * * @type {Array<string>} * @memberof SessionSpec */ 'envVarsFromSecrets'?: Array<string>; } /** * A request to start a session * @export * @interface SessionStartRequest */ export interface SessionStartRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof SessionStartRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof SessionStartRequest */ 'user': string; /** * The app to launch. * @type {string} * @memberof SessionStartRequest */ 'appDefinition': string; /** * The name of the workspace to mount/create. * @type {string} * @memberof SessionStartRequest */ 'workspaceName'?: string; /** * Number of minutes to wait for session launch. Default is 3 Minutes. * @type {number} * @memberof SessionStartRequest */ 'timeout'?: number; /** * Environment variables * @type {EnvironmentVars} * @memberof SessionStartRequest */ 'env'?: EnvironmentVars; } /** * A request to stop a session * @export * @interface SessionStopRequest */ export interface SessionStopRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof SessionStopRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof SessionStopRequest */ 'user': string; /** * The name of the session to stop. * @type {string} * @memberof SessionStopRequest */ 'sessionName': string; } /** * Description of a user workspace * @export * @interface UserWorkspace */ export interface UserWorkspace { /** * The name of the workspace * @type {string} * @memberof UserWorkspace */ 'name': string; /** * The label of the workspace * @type {string} * @memberof UserWorkspace */ 'label': string; /** * The app this workspace was used with. * @type {string} * @memberof UserWorkspace */ 'appDefinition'?: string; /** * The user identification, usually the email address. * @type {string} * @memberof UserWorkspace */ 'user': string; /** * Whether the workspace is in use at the moment. * @type {boolean} * @memberof UserWorkspace */ 'active': boolean; } /** * Request to create a new workspace. * @export * @interface WorkspaceCreationRequest */ export interface WorkspaceCreationRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof WorkspaceCreationRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof WorkspaceCreationRequest */ 'user': string; /** * The app this workspace will be used with. * @type {string} * @memberof WorkspaceCreationRequest */ 'appDefinition'?: string; /** * The label of the workspace * @type {string} * @memberof WorkspaceCreationRequest */ 'label'?: string; } /** * Request to delete a workspace * @export * @interface WorkspaceDeletionRequest */ export interface WorkspaceDeletionRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof WorkspaceDeletionRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof WorkspaceDeletionRequest */ 'user': string; /** * The name of the workspace to delete. * @type {string} * @memberof WorkspaceDeletionRequest */ 'workspaceName': string; } /** * Request to list workspaces of a user. * @export * @interface WorkspaceListRequest */ export interface WorkspaceListRequest { /** * The App Id of this Theia Cloud instance. Request without a matching Id will be denied. * @type {string} * @memberof WorkspaceListRequest */ 'appId': string; /** * The user identification, usually the email address. * @type {string} * @memberof WorkspaceListRequest */ 'user': string; } /** * AppDefinitionAdminResourceApi - axios parameter creator * @export */ export declare const AppDefinitionAdminResourceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Updates an app definition\'s properties. Allowed properties to update are defined by AppDefinitionUpdateRequest. * @summary Updates an app definition * @param {string} appDefinitionName The K8S resource name of the app definition to update. * @param {AppDefinitionUpdateRequest} appDefinitionUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAdminAppdefinitionAppDefinitionNamePatch: (appDefinitionName: string, appDefinitionUpdateRequest: AppDefinitionUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * AppDefinitionAdminResourceApi - functional programming interface * @export */ export declare const AppDefinitionAdminResourceApiFp: (configuration?: Configuration) => { /** * Updates an app definition\'s properties. Allowed properties to update are defined by AppDefinitionUpdateRequest. * @summary Updates an app definition * @param {string} appDefinitionName The K8S resource name of the app definition to update. * @param {AppDefinitionUpdateRequest} appDefinitionUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAdminAppdefinitionAppDefinitionNamePatch(appDefinitionName: string, appDefinitionUpdateRequest: AppDefinitionUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AppDefinition>>; }; /** * AppDefinitionAdminResourceApi - factory interface * @export */ export declare const AppDefinitionAdminResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Updates an app definition\'s properties. Allowed properties to update are defined by AppDefinitionUpdateRequest. * @summary Updates an app definition * @param {string} appDefinitionName The K8S resource name of the app definition to update. * @param {AppDefinitionUpdateRequest} appDefinitionUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAdminAppdefinitionAppDefinitionNamePatch(appDefinitionName: string, appDefinitionUpdateRequest: AppDefinitionUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<AppDefinition>; }; /** * AppDefinitionAdminResourceApi - object-oriented interface * @export * @class AppDefinitionAdminResourceApi * @extends {BaseAPI} */ export declare class AppDefinitionAdminResourceApi extends BaseAPI { /** * Updates an app definition\'s properties. Allowed properties to update are defined by AppDefinitionUpdateRequest. * @summary Updates an app definition * @param {string} appDefinitionName The K8S resource name of the app definition to update. * @param {AppDefinitionUpdateRequest} appDefinitionUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AppDefinitionAdminResourceApi */ serviceAdminAppdefinitionAppDefinitionNamePatch(appDefinitionName: string, appDefinitionUpdateRequest: AppDefinitionUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppDefinition, any>>; } /** * AppDefinitionResourceApi - axios parameter creator * @export */ export declare const AppDefinitionResourceApiAxiosParamCreator: (configuration?: Configuration) => { /** * List available app definitions. * @summary List app definitions * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAppdefinitionAppIdGet: (appId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * AppDefinitionResourceApi - functional programming interface * @export */ export declare const AppDefinitionResourceApiFp: (configuration?: Configuration) => { /** * List available app definitions. * @summary List app definitions * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAppdefinitionAppIdGet(appId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AppDefinitionSpec>>>; }; /** * AppDefinitionResourceApi - factory interface * @export */ export declare const AppDefinitionResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List available app definitions. * @summary List app definitions * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAppdefinitionAppIdGet(appId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AppDefinitionSpec>>; }; /** * AppDefinitionResourceApi - object-oriented interface * @export * @class AppDefinitionResourceApi * @extends {BaseAPI} */ export declare class AppDefinitionResourceApi extends BaseAPI { /** * List available app definitions. * @summary List app definitions * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AppDefinitionResourceApi */ serviceAppdefinitionAppIdGet(appId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AppDefinitionSpec[], any>>; } /** * RootAdminResourceApi - axios parameter creator * @export */ export declare const RootAdminResourceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Replies with success if the service is available and the user an admin. * @summary Admin Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAdminAppIdGet: (appId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * RootAdminResourceApi - functional programming interface * @export */ export declare const RootAdminResourceApiFp: (configuration?: Configuration) => { /** * Replies with success if the service is available and the user an admin. * @summary Admin Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAdminAppIdGet(appId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>; }; /** * RootAdminResourceApi - factory interface * @export */ export declare const RootAdminResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Replies with success if the service is available and the user an admin. * @summary Admin Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAdminAppIdGet(appId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>; }; /** * RootAdminResourceApi - object-oriented interface * @export * @class RootAdminResourceApi * @extends {BaseAPI} */ export declare class RootAdminResourceApi extends BaseAPI { /** * Replies with success if the service is available and the user an admin. * @summary Admin Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RootAdminResourceApi */ serviceAdminAppIdGet(appId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>; } /** * RootResourceApi - axios parameter creator * @export */ export declare const RootResourceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Replies if the service is available. * @summary Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAppIdGet: (appId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Launches a session and creates a workspace if required. Responds with the URL of the launched session. * @summary Launch Session * @param {LaunchRequest} launchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ servicePost: (launchRequest: LaunchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * RootResourceApi - functional programming interface * @export */ export declare const RootResourceApiFp: (configuration?: Configuration) => { /** * Replies if the service is available. * @summary Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAppIdGet(appId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>; /** * Launches a session and creates a workspace if required. Responds with the URL of the launched session. * @summary Launch Session * @param {LaunchRequest} launchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ servicePost(launchRequest: LaunchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; }; /** * RootResourceApi - factory interface * @export */ export declare const RootResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Replies if the service is available. * @summary Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceAppIdGet(appId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>; /** * Launches a session and creates a workspace if required. Responds with the URL of the launched session. * @summary Launch Session * @param {LaunchRequest} launchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ servicePost(launchRequest: LaunchRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>; }; /** * RootResourceApi - object-oriented interface * @export * @class RootResourceApi * @extends {BaseAPI} */ export declare class RootResourceApi extends BaseAPI { /** * Replies if the service is available. * @summary Ping * @param {string} appId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RootResourceApi */ serviceAppIdGet(appId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>; /** * Launches a session and creates a workspace if required. Responds with the URL of the launched session. * @summary Launch Session * @param {LaunchRequest} launchRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RootResourceApi */ servicePost(launchRequest: LaunchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>; } /** * SessionResourceApi - axios parameter creator * @export */ export declare const SessionResourceApiAxiosParamCreator: (configuration?: Configuration) => { /** * List sessions of a user. * @summary List sessions * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionAppIdUserGet: (appId: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Stops a session. * @summary Stop session * @param {SessionStopRequest} sessionStopRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionDelete: (sessionStopRequest: SessionStopRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Updates the last activity timestamp for a session to monitor activity. * @summary Report session activity * @param {SessionActivityRequest} sessionActivityRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPatch: (sessionActivityRequest: SessionActivityRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Returns the current CPU and memory usage of the session\'s pod. * @summary Get performance metrics * @param {string} appId * @param {string} sessionName * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPerformanceAppIdSessionNameGet: (appId: string, sessionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Starts a new session for an existing workspace and responds with the URL of the started session. * @summary Start a new session * @param {SessionStartRequest} sessionStartRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPost: (sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Sets a config value in the config store if it is available. This requires the @eclipse-theiacloud/config-store Theia extension to be present in the application. * @summary Set config value * @param {string} session The name of the session * @param {SessionSetConfigValueRequest} sessionSetConfigValueRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionSessionConfigPost: (session: string, sessionSetConfigValueRequest: SessionSetConfigValueRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * SessionResourceApi - functional programming interface * @export */ export declare const SessionResourceApiFp: (configuration?: Configuration) => { /** * List sessions of a user. * @summary List sessions * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionAppIdUserGet(appId: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SessionSpec>>>; /** * Stops a session. * @summary Stop session * @param {SessionStopRequest} sessionStopRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionDelete(sessionStopRequest: SessionStopRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>; /** * Updates the last activity timestamp for a session to monitor activity. * @summary Report session activity * @param {SessionActivityRequest} sessionActivityRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPatch(sessionActivityRequest: SessionActivityRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>; /** * Returns the current CPU and memory usage of the session\'s pod. * @summary Get performance metrics * @param {string} appId * @param {string} sessionName * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPerformanceAppIdSessionNameGet(appId: string, sessionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionPerformance>>; /** * Starts a new session for an existing workspace and responds with the URL of the started session. * @summary Start a new session * @param {SessionStartRequest} sessionStartRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPost(sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Sets a config value in the config store if it is available. This requires the @eclipse-theiacloud/config-store Theia extension to be present in the application. * @summary Set config value * @param {string} session The name of the session * @param {SessionSetConfigValueRequest} sessionSetConfigValueRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionSessionConfigPost(session: string, sessionSetConfigValueRequest: SessionSetConfigValueRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; }; /** * SessionResourceApi - factory interface * @export */ export declare const SessionResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List sessions of a user. * @summary List sessions * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionAppIdUserGet(appId: string, user: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<SessionSpec>>; /** * Stops a session. * @summary Stop session * @param {SessionStopRequest} sessionStopRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionDelete(sessionStopRequest: SessionStopRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>; /** * Updates the last activity timestamp for a session to monitor activity. * @summary Report session activity * @param {SessionActivityRequest} sessionActivityRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPatch(sessionActivityRequest: SessionActivityRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>; /** * Returns the current CPU and memory usage of the session\'s pod. * @summary Get performance metrics * @param {string} appId * @param {string} sessionName * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPerformanceAppIdSessionNameGet(appId: string, sessionName: string, options?: RawAxiosRequestConfig): AxiosPromise<SessionPerformance>; /** * Starts a new session for an existing workspace and responds with the URL of the started session. * @summary Start a new session * @param {SessionStartRequest} sessionStartRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionPost(sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>; /** * Sets a config value in the config store if it is available. This requires the @eclipse-theiacloud/config-store Theia extension to be present in the application. * @summary Set config value * @param {string} session The name of the session * @param {SessionSetConfigValueRequest} sessionSetConfigValueRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceSessionSessionConfigPost(session: string, sessionSetConfigValueRequest: SessionSetConfigValueRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; }; /** * SessionResourceApi - object-oriented interface * @export * @class SessionResourceApi * @extends {BaseAPI} */ export declare class SessionResourceApi extends BaseAPI { /** * List sessions of a user. * @summary List sessions * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SessionResourceApi */ serviceSessionAppIdUserGet(appId: string, user: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SessionSpec[], any>>; /** * Stops a session. * @summary Stop session * @param {SessionStopRequest} sessionStopRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SessionResourceApi */ serviceSessionDelete(sessionStopRequest: SessionStopRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>; /** * Updates the last activity timestamp for a session to monitor activity. * @summary Report session activity * @param {SessionActivityRequest} sessionActivityRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SessionResourceApi */ serviceSessionPatch(sessionActivityRequest: SessionActivityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>; /** * Returns the current CPU and memory usage of the session\'s pod. * @summary Get performance metrics * @param {string} appId * @param {string} sessionName * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SessionResourceApi */ serviceSessionPerformanceAppIdSessionNameGet(appId: string, sessionName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SessionPerformance, any>>; /** * Starts a new session for an existing workspace and responds with the URL of the started session. * @summary Start a new session * @param {SessionStartRequest} sessionStartRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SessionResourceApi */ serviceSessionPost(sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>; /** * Sets a config value in the config store if it is available. This requires the @eclipse-theiacloud/config-store Theia extension to be present in the application. * @summary Set config value * @param {string} session The name of the session * @param {SessionSetConfigValueRequest} sessionSetConfigValueRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SessionResourceApi */ serviceSessionSessionConfigPost(session: string, sessionSetConfigValueRequest: SessionSetConfigValueRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; } /** * WorkspaceResourceApi - axios parameter creator * @export */ export declare const WorkspaceResourceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Lists the workspaces of a user. * @summary List workspaces * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspaceAppIdUserGet: (appId: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Deletes a workspace. * @summary Delete workspace * @param {WorkspaceDeletionRequest} workspaceDeletionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspaceDelete: (workspaceDeletionRequest: WorkspaceDeletionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Creates a new workspace for a user. * @summary Create workspace * @param {WorkspaceCreationRequest} workspaceCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspacePost: (workspaceCreationRequest: WorkspaceCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * WorkspaceResourceApi - functional programming interface * @export */ export declare const WorkspaceResourceApiFp: (configuration?: Configuration) => { /** * Lists the workspaces of a user. * @summary List workspaces * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspaceAppIdUserGet(appId: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserWorkspace>>>; /** * Deletes a workspace. * @summary Delete workspace * @param {WorkspaceDeletionRequest} workspaceDeletionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspaceDelete(workspaceDeletionRequest: WorkspaceDeletionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>; /** * Creates a new workspace for a user. * @summary Create workspace * @param {WorkspaceCreationRequest} workspaceCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspacePost(workspaceCreationRequest: WorkspaceCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWorkspace>>; }; /** * WorkspaceResourceApi - factory interface * @export */ export declare const WorkspaceResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Lists the workspaces of a user. * @summary List workspaces * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspaceAppIdUserGet(appId: string, user: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserWorkspace>>; /** * Deletes a workspace. * @summary Delete workspace * @param {WorkspaceDeletionRequest} workspaceDeletionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspaceDelete(workspaceDeletionRequest: WorkspaceDeletionRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>; /** * Creates a new workspace for a user. * @summary Create workspace * @param {WorkspaceCreationRequest} workspaceCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ serviceWorkspacePost(workspaceCreationRequest: WorkspaceCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserWorkspace>; }; /** * WorkspaceResourceApi - object-oriented interface * @export * @class WorkspaceResourceApi * @extends {BaseAPI} */ export declare class WorkspaceResourceApi extends BaseAPI { /** * Lists the workspaces of a user. * @summary List workspaces * @param {string} appId * @param {string} user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspaceResourceApi */ serviceWorkspaceAppIdUserGet(appId: string, user: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserWorkspace[], any>>; /** * Deletes a workspace. * @summary Delete workspace * @param {WorkspaceDeletionRequest} workspaceDeletionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspaceResourceApi */ serviceWorkspaceDelete(workspaceDeletionRequest: WorkspaceDeletionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>; /** * Creates a new workspace for a user. * @summary Create workspace * @param {WorkspaceCreationRequest} workspaceCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspaceResourceApi */ serviceWorkspacePost(workspaceCreationRequest: WorkspaceCreationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserWorkspace, any>>; } //# sourceMappingURL=api.d.ts.map