teraslice-client-js / job / default

Class: default

Extends

• default

Constructors

new default()

new default(config, jobId): default

Parameters

Parameter	Type
config	ClientConfig
jobId	string

Returns

default

Overrides

default.constructor

Source

job.ts:26

Properties

_config

protected readonly _config: ClientConfig

Inherited from

default._config

Source

client.ts:14

Methods

changeWorkers()

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

Parameters

Parameter	Type
action	ChangeWorkerQueryParams
workerNum	number
requestOptions	Partial<default>

Returns

Promise<string | ChangeWorkerResponse>

Source

job.ts:205

---

config()

config(requestOptions): Promise<JobConfig>

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

Promise<JobConfig>

Source

job.ts:189

---

controller()

controller(requestOptions): Promise<ExecutionList>

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

Promise<ExecutionList>

Source

job.ts:46

---

delete()

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

Type parameters

Type parameter	Value
T	any

Parameters

Parameter	Type
endpoint	string
options?	Partial<default>

Returns

Promise<T>

Inherited from

default.delete

Source

client.ts:54

---

deleteJob()

deleteJob(): Promise<JobConfig>

Returns

Promise<JobConfig>

Source

job.ts:102

---

errors()

errors(query, searchOptions): Promise<ErrorRecord[]>

Parameters

Parameter	Type
query	SearchQuery
searchOptions	Partial<default>

Returns

Promise<ErrorRecord[]>

Source

job.ts:193

---

exId()

exId(requestOptions): Promise<ExecutionIDResponse>

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

Promise<ExecutionIDResponse>

Source

job.ts:110

---

execution()

execution(requestOptions): Promise<ExecutionConfig>

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

Promise<ExecutionConfig>

Source

job.ts:106

---

get()

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

Type parameters

Type parameter	Value
T	any

Parameters

Parameter	Type
endpoint	string
options?	Partial<default>

Returns

Promise<T>

Inherited from

default.get

Source

client.ts:42

---

id()

id(): string

Returns

string

Source

job.ts:38

---

makeOptions()

protected makeOptions(searchParams, options): Partial<default>

Parameters

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

Returns

Partial<default>

Inherited from

default.makeOptions

Source

client.ts:110

---

parse()

protected parse(results): any

Parameters

Parameter	Type
results	unknown

Returns

any

Inherited from

default.parse

Source

client.ts:106

---

pause()

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

Parameters

Parameter	Type
query?	SearchQuery
searchOptions?	Partial<default>

Returns

Promise<ApiPausedResponse>

Source

job.ts:66

---

post()

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

Type parameters

Type parameter	Value
T	any

Parameters

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

Returns

Promise<T>

Inherited from

default.post

Source

client.ts:46

---

put()

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

Type parameters

Type parameter	Value
T	any

Parameters

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

Returns

Promise<T>

Inherited from

default.put

Source

client.ts:50

---

recover()

recover(query, searchOptions): Promise<ApiJobCreateResponse>

Parameters

Parameter	Type
query	RecoverQuery
searchOptions	Partial<default>

Returns

Promise<ApiJobCreateResponse>

Source

job.ts:82

---

resume()

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

Parameters

Parameter	Type
query?	SearchQuery
searchOptions?	Partial<default>

Returns

Promise<ApiResumeResponse>

Source

job.ts:74

---

slicer()

slicer(requestOptions): Promise<ExecutionList>

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

Promise<ExecutionList>

Source

job.ts:42

---

start()

start(query?, searchOptions?): Promise<ApiJobCreateResponse>

Parameters

Parameter	Type
query?	SearchQuery
searchOptions?	Partial<default>

Returns

Promise<ApiJobCreateResponse>

Source

job.ts:50

---

status()

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

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

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

Source

job.ts:115

---

stop()

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

Parameters

Parameter	Type
query?	StopQuery
searchOptions?	Partial<default>

Returns

Promise<ApiStoppedResponse>

Source

job.ts:58

---

update()

update(jobSpec): Promise<JobConfig>

Parameters

Parameter	Type
jobSpec	JobConfig

Returns

Promise<JobConfig>

Source

job.ts:90

---

updatePartial()

updatePartial(jobSpec): Promise<JobConfig>

Parameters

Parameter	Type
jobSpec	Partial<JobConfig>

Returns

Promise<JobConfig>

Source

job.ts:94

---

waitForStatus()

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

Parameters

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

Returns

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

Source

job.ts:120

---

workers()

workers(requestOptions): Promise<WorkerNode[]>

Parameters

Parameter	Type
requestOptions	Partial<default>

Returns

Promise<WorkerNode[]>

Source

job.ts:200