teraslice-client-js / ex / default

Class: default

Defined in: ex.ts:10

Extends

• default

Constructors

new default()

new default(config, exId): default

Defined in: ex.ts:13

Parameters

Parameter	Type
config	ClientConfig
exId	string

Returns

default

Overrides

default.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
_config	readonly	ClientConfig	default._config	client.ts:14

Methods

changeWorkers()

changeWorkers(action, workerNum, requestOptions): Promise<string | ChangeWorkerResponse>

Defined in: ex.ts:94

Parameters

Parameter	Type
action	ChangeWorkerQueryParams
workerNum	number
requestOptions	Partial

Returns

Promise<string | ChangeWorkerResponse>

---

config()

config(requestOptions): Promise<ExecutionConfig>

Defined in: ex.ts:79

Parameters

Parameter	Type
requestOptions	Partial

Returns

Promise<ExecutionConfig>

---

controller()

controller(requestOptions): Promise<ExecutionList>

Defined in: ex.ts:75

Parameters

Parameter	Type
requestOptions	Partial

Returns

Promise<ExecutionList>

---

delete()

delete<T>(endpoint, options?): Promise<T>

Defined in: client.ts:54

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.delete

---

errors()

errors(options?): Promise<ErrorRecord[]>

Defined in: ex.ts:88

Parameters

Parameter	Type
options?	SearchQuery

Returns

Promise<ErrorRecord[]>

---

get()

get<T>(endpoint, options?): Promise<T>

Defined in: client.ts:42

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.get

---

id()

id(): string

Defined in: ex.ts:22

Returns

string

---

makeOptions()

protected makeOptions(searchParams, options): Partial

Defined in: client.ts:110

Parameters

Parameter	Type
searchParams	undefined | Record<string, any>
options	Partial

Returns

Partial

Inherited from

default.makeOptions

---

parse()

protected parse(results): any

Defined in: client.ts:106

Parameters

Parameter	Type
results	unknown

Returns

any

Inherited from

default.parse

---

pause()

pause(query?, searchOptions?): Promise<ApiPausedResponse>

Defined in: ex.ts:34

Parameters

Parameter	Type
query?	SearchQuery
searchOptions?	Partial

Returns

Promise<ApiPausedResponse>

---

post()

post<T>(endpoint, data?, options?): Promise<T>

Defined in: client.ts:46

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
data?	unknown
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.post

---

put()

put<T>(endpoint, data, options?): Promise<T>

Defined in: client.ts:50

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
data	unknown
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.put

---

recover()

recover(query, searchOptions): Promise<default>

Defined in: ex.ts:50

Parameters

Parameter	Type
query	RecoverQuery
searchOptions	Partial

Returns

Promise<default>

---

resume()

resume(query?, searchOptions?): Promise<ApiResumeResponse>

Defined in: ex.ts:42

Parameters

Parameter	Type
query?	SearchQuery
searchOptions?	Partial

Returns

Promise<ApiResumeResponse>

---

slicer()

slicer(requestOptions): Promise<ExecutionList>

Defined in: ex.ts:71

Parameters

Parameter	Type
requestOptions	Partial

Returns

Promise<ExecutionList>

---

status()

status(requestOptions?): Promise<"pending" | "scheduling" | "initializing" | "running" | "recovering" | "failing" | "paused" | "stopping" | "completed" | "stopped" | "rejected" | "failed" | "terminated">

Defined in: ex.ts:66

Parameters

Parameter	Type
requestOptions?	Partial<Options>

Returns

Promise<"pending" | "scheduling" | "initializing" | "running" | "recovering" | "failing" | "paused" | "stopping" | "completed" | "stopped" | "rejected" | "failed" | "terminated">

---

stop()

stop(query?, searchOptions?): Promise<ApiStoppedResponse>

Defined in: ex.ts:26

Parameters

Parameter	Type
query?	StopQuery
searchOptions?	Partial

Returns

Promise<ApiStoppedResponse>

---

waitForStatus()

waitForStatus(target, intervalMs, timeoutMs, requestOptions): Promise<"pending" | "scheduling" | "initializing" | "running" | "recovering" | "failing" | "paused" | "stopping" | "completed" | "stopped" | "rejected" | "failed" | "terminated">

Defined in: ex.ts:127

Parameters

Parameter	Type	Default value
target	"pending" | "scheduling" | "initializing" | "running" | "recovering" | "failing" | "paused" | "stopping" | "completed" | "stopped" | "rejected" | "failed" | "terminated"	undefined
intervalMs	number	1000
timeoutMs	number	0
requestOptions	Partial	{}

Returns

Promise<"pending" | "scheduling" | "initializing" | "running" | "recovering" | "failing" | "paused" | "stopping" | "completed" | "stopped" | "rejected" | "failed" | "terminated">

---

workers()

workers(requestOptions): Promise<WorkerNode[]>

Defined in: ex.ts:83

Parameters

Parameter	Type
requestOptions	Partial

Returns

Promise<WorkerNode[]>