default | cybergis-compute-core

Hierarchy

default
- default

Constructors

constructor

new default(hpcName: string, jobId?: string, maintainer?: default, env?: {}, is_cvmfs?: boolean): default

- Defined in src/connectors/BaseConnector.ts:38
Parameters
- hpcName: string
- jobId: string = null
- maintainer: default = null
- env: {} = {}
  - [keys: string]: any
- is_cvmfs: boolean = false
Returns default

Properties

config

config: hpcConfig

config

db

db: default = ...

Protected envCmd

envCmd: string = "#!/bin/bash\n"

hpcName

hpcName: string

is_cvmfs

is_cvmfs: boolean

jobId

jobId: string

properties

maintainer

maintainer: default

parent pointer

remote_data_folder_path

remote_data_folder_path: string

remote_executable_folder_path

remote_executable_folder_path: string

remote_result_folder_path

remote_result_folder_path: string

Methods

cat

cat(path: string, options?: options): Promise<string>

- Defined in src/connectors/BaseConnector.ts:288
aysnc
creates an empty file at specified path

param(string)
path - specified path with filename

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- path: string
- options: options = {}
Returns Promise<string>

createFile

createFile(content: string | Object, remotePath: string, options?: options, muteEvent?: boolean): Promise<void>

- Defined in src/connectors/BaseConnector.ts:443
aysnc
creates file with specified content

param(string)
content - file content

param(string)
path - specified path with filename

param(object)
options - dictionary with string options

Parameters
- content: string | Object
- remotePath: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<void>

download

download(from: string, to: string, muteEvent?: boolean): Promise<void>

- Defined in src/connectors/BaseConnector.ts:159
aysnc
Uncompresses the specified zip file to the Local folder

throws
{ConnectorError} - Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

Parameters
- from: string
  
  input file string
- to: string
  
  output folder
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<void>

exec

exec(commands: string | string[], options?: options, muteEvent?: boolean, muteLog?: boolean, continueOnError?: boolean): Promise<out>

- Defined in src/connectors/BaseConnector.ts:85
async
Executes the command on the maintainer and returns the outpt

Parameters
- commands: string | string[]
  
  command/commands that need to be executed
- options: options = {}
  
  execution options
- muteEvent: boolean = true
  
  set to True if you want to mute maintauner emitted Event
- muteLog: boolean = true
  
  set to True if you want to mute maintainer emitted Log
- continueOnError: boolean = false
  
  set to True if you want the command/commands to continue despite errors
Returns Promise<out>
out - maintainer output

getRemoteDataFolderPath

getRemoteDataFolderPath(providedPath?: string): string

- Defined in src/connectors/BaseConnector.ts:499
gets remote data folder path

param(string)
providedPath - specified path

return(object)
returns - command execution output

Parameters
- providedPath: string = null
Returns string

getRemoteExecutableFolderPath

getRemoteExecutableFolderPath(providedPath?: string): string

- Defined in src/connectors/BaseConnector.ts:485
gets remote executable folder path

param(string)
providedPath - specified path

return(object)
returns - command execution output

Parameters
- providedPath: string = null
Returns string

getRemoteResultFolderPath

getRemoteResultFolderPath(providedPath?: string): string

- Defined in src/connectors/BaseConnector.ts:512
gets remote result folder path

param(string)
providedPath - specified path

return(object)
returns - command execution output

Parameters
- providedPath: string = null
Returns string

homeDirectory

homeDirectory(options?: options): Promise<string>

- Defined in src/connectors/BaseConnector.ts:233
aysnc
Returns the homeDirectory path

param{object}
options - dictionary with string options

return{object}
- returns command execution output
Parameters
- options: options = {}
Returns Promise<string>

ls

ls(path?: string, options?: options): Promise<string>

- Defined in src/connectors/BaseConnector.ts:273
aysnc
Returns all of the files/directories in specified path

param{string}
path - specified path

param{object}
options - dictionary with string options

return{object}
- returns command execution output
Parameters
- path: string = undefined
- options: options = {}
Returns Promise<string>

mkdir

mkdir(path: string, options?: options, muteEvent?: boolean): Promise<string>

- Defined in src/connectors/BaseConnector.ts:320
aysnc
creates directory at specified path

param(string)
path - specified path with filename

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- path: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<string>

pwd

pwd(path?: string, options?: options): Promise<string>

- Defined in src/connectors/BaseConnector.ts:258
aysnc
Returns the specified path

param{string}
path - execution path

param{object}
options - dictionary with string options

return{object}
- returns command execution output
Parameters
- path: string = undefined
- options: options = {}
Returns Promise<string>

rm

rm(path: string, options?: options, muteEvent?: boolean): Promise<string>

- Defined in src/connectors/BaseConnector.ts:304
aysnc
removes the file/folder at specified path

param(string)
path - specified path with filename

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- path: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<string>

setRemoteDataFolderPath

setRemoteDataFolderPath(providedPath: string): void

- Defined in src/connectors/BaseConnector.ts:528
Parameters
- providedPath: string
Returns void

setRemoteExecutableFolderPath

setRemoteExecutableFolderPath(providedPath: string): void

- Defined in src/connectors/BaseConnector.ts:524
Parameters
- providedPath: string
Returns void

setRemoteResultFolderPath

setRemoteResultFolderPath(providedPath: string): void

- Defined in src/connectors/BaseConnector.ts:532
Parameters
- providedPath: string
Returns void

ssh

ssh(): SSH

- Defined in src/connectors/BaseConnector.ts:66
Returns ssh connection from maintainer configuration

Returns SSH

tar

tar(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>

- Defined in src/connectors/BaseConnector.ts:391
aysnc
tars the file/directory at specified path

param(string)
from - input file/directory path

param(string)
to - compress file path with file name

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- from: string
- to: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<string>

transferFile

transferFile(from: string, to: string, muteEvent?: boolean): Promise<void>

- Defined in src/connectors/BaseConnector.ts:191
aysnc
Transfers a file from the local machine to remote machine

throws
{ConnectorError} - Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

Parameters
- from: string
  
  input file string
- to: string
  
  output folder
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<void>

untar

untar(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>

- Defined in src/connectors/BaseConnector.ts:422
aysnc
untars the file/directory at specified path

param(string)
from - input file/directory path

param(string)
to - compress file path with file name

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- from: string
- to: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<string>

unzip

unzip(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>

- Defined in src/connectors/BaseConnector.ts:367
aysnc
unzips the file/folder at specified path

param(string)
from - input file/directory path

param(string)
to - compress file path with file name

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- from: string
- to: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<string>

upload

upload(from: string, to: string, muteEvent?: boolean): Promise<void>

- Defined in src/connectors/BaseConnector.ts:216
aysnc
Compresses the contents of the LocalFolder to the specified zip file

throws
{ConnectorError} - Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

Parameters
- from: string
  
  input file string
- to: string
  
  output folder
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<void>

whoami

whoami(options?: options): Promise<string>

- Defined in src/connectors/BaseConnector.ts:245
aysnc
Returns the username

param{object}
options - dictionary with string options

return{object}
- returns command execution output
Parameters
- options: options = {}
Returns Promise<string>

zip

zip(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>

- Defined in src/connectors/BaseConnector.ts:337
aysnc
zips the file/directory at specified path

param(string)
from - input file/directory path

param(string)
to - compress file path with file name

param(object)
options - dictionary with string options

return(object)
returns - command execution output

Parameters
- from: string
- to: string
- options: options = {}
- muteEvent: boolean = false
  
  set to True if you want to mute maintauner emitted Event
Returns Promise<string>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

hpcName: string

jobId: string = null

maintainer: default = null

env: {} = {}

[keys: string]: any

is_cvmfs: boolean = false

Returns default

Properties

config

db

Protected envCmd

hpcName

is_cvmfs

jobId

maintainer

remote_data_folder_path

remote_executable_folder_path

remote_result_folder_path

Methods

cat

Parameters

path: string

options: options = {}

Returns Promise<string>

createFile

Parameters

content: string | Object

remotePath: string

options: options = {}

muteEvent: boolean = false

Returns Promise<void>

download

Parameters

from: string

to: string

muteEvent: boolean = false

Returns Promise<void>

exec

Parameters

commands: string | string[]

options: options = {}

muteEvent: boolean = true

muteLog: boolean = true

continueOnError: boolean = false

Returns Promise<out>

getRemoteDataFolderPath

Parameters

providedPath: string = null

Returns string

getRemoteExecutableFolderPath

Parameters

providedPath: string = null

Returns string

getRemoteResultFolderPath

Parameters

providedPath: string = null

Returns string

homeDirectory

Parameters

options: options = {}

Returns Promise<string>

ls

Parameters

path: string = undefined

options: options = {}

Returns Promise<string>

mkdir

Parameters

path: string

options: options = {}

muteEvent: boolean = false

Returns Promise<string>