Class default

Implementation of MLEnginesApiClient that goes through the REST API.

Hierarchy

default
- default

Index

Constructors

constructor

new default(sqlClient: default, client: Axios, authenticator: default): default
Parameters
- sqlClient: default
  
  SQL API client to send all SQL query requests.
- client: Axios
- authenticator: default
Returns default
Overrides default.constructor
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:31

Properties

authenticator

authenticator: default

Authenticator to use for reauthenticating if needed.

client

client: Axios

Axios client to send all HTTP requests.

sqlClient

sqlClient: default

SQL API client to send all SQL query requests.

Methods

createMLEngine

createMLEngine(name: string, codeFilePath?: string | Readable, modulesFilePath?: string | Readable): Promise<undefined | default>
Creates a mlEngine with the given name, engine, and parameters.

Returns
- Newly created mlEngine.
Throws
- Something went wrong creating the mlEngine.
Parameters
- name: string
  
  Name of the MLEngine to be created.
- Optional codeFilePath: string | Readable
  
  Path to the code file or Readable of to be used for the mlEngine.
- Optional modulesFilePath: string | Readable
  
  Path to the modules file or Readable of to be used for the mlEngine.
Returns Promise<undefined | default>
Overrides default.createMLEngine
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:152

`Private` createOrUpdateMLEngine

createOrUpdateMLEngine(httpMethod: "post" | "put", name: string, codeFilePathOrStream: string | Readable, modulesFilePathOrStream: string | Readable): Promise<undefined | default>
Parameters
- httpMethod: "post" | "put"
- name: string
- codeFilePathOrStream: string | Readable
- modulesFilePathOrStream: string | Readable
Returns Promise<undefined | default>
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:70

deleteMLEngine

deleteMLEngine(name: string): Promise<void>
Deletes a mlEngine by name.

Throws
- Something went wrong deleting the mlEngine.
Parameters
- name: string
  
  Name of the mlEngine to be deleted.
Returns Promise<void>
Overrides default.deleteMLEngine
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:225

getAllMLEngines

getAllMLEngines(): Promise<default[]>
Gets all mlEngines for the authenticated user.

Returns
- All mlEngines for the user.
Returns Promise<default[]>
Overrides default.getAllMLEngines
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:172

getMLEngine

getMLEngine(name: string): Promise<undefined | default>
Gets a mlEngine by name for the authenticated user.

Returns
- Matching mlEngine, or undefined if it doesn't exist.
Parameters
- name: string
  
  Name of the mlEngine.
Returns Promise<undefined | default>
Overrides default.getMLEngine
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:191

`Private` getMLEnginesUrl

getMLEnginesUrl(): string
Returns string
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:42

`Private` parseJson

parseJson(json?: string): any
Parameters
- Optional json: string
Returns any
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:206

updateMLEngine

updateMLEngine(name: string, codeFilePath?: string | Readable, modulesFilePath?: string | Readable): Promise<undefined | default>
Updates a mlEngine with the given name, engine, and parameters.

Returns
- Newly created mlEngine.
Throws
- Something went wrong creating the mlEngine.
Parameters
- name: string
  
  Name of the MLEngine to be created.
- Optional codeFilePath: string | Readable
  
  Path to the code file or Readable of to be used for the mlEngine.
- Optional modulesFilePath: string | Readable
  
  Path to the modules file or Readable of to be used for the mlEngine.
Returns Promise<undefined | default>
Overrides default.updateMLEngine
- Defined in src/ml_engines/ml_enginesRestApiClient.ts:57

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sqlClient: default

client: Axios

authenticator: default

Returns default

Properties

authenticator

client

sqlClient

Methods

createMLEngine

Returns

Throws

Parameters

name: string

Optional codeFilePath: string | Readable

Optional modulesFilePath: string | Readable

Returns Promise<undefined | default>

Private createOrUpdateMLEngine

Parameters

httpMethod: "post" | "put"

name: string

codeFilePathOrStream: string | Readable

modulesFilePathOrStream: string | Readable

Returns Promise<undefined | default>

deleteMLEngine

Throws

Parameters

name: string

Returns Promise<void>

getAllMLEngines

Returns

Returns Promise<default[]>

getMLEngine

Returns

Parameters

name: string

Returns Promise<undefined | default>

Private getMLEnginesUrl

Returns string

Private parseJson

Parameters

Optional json: string

Returns any

updateMLEngine

Returns

Throws

Parameters

name: string

Optional codeFilePath: string | Readable

Optional modulesFilePath: string | Readable

Returns Promise<undefined | default>

Settings

Member Visibility

Theme

`Optional` codeFilePath: string | Readable

`Optional` modulesFilePath: string | Readable

`Private` createOrUpdateMLEngine

`Private` getMLEnginesUrl

`Private` parseJson

`Optional` json: string

`Optional` codeFilePath: string | Readable

`Optional` modulesFilePath: string | Readable