teraslice-client-js / jobs / default

Class: default

Extends

• default

Constructors

new default()

new default(config): default

Parameters

Parameter	Type
config	ClientConfig

Returns

default

Overrides

default.constructor

Source

jobs.ts:9

Properties

_config

protected readonly _config: ClientConfig

Inherited from

default._config

Source

client.ts:14

Methods

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

---

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

---

list()

list(query?, searchOptions?): Promise<JobConfig[]>

Parameters

Parameter	Type
query?	JobSearchParams
searchOptions?	Partial<default>

Returns

Promise<JobConfig[]>

Source

jobs.ts:28

---

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

---

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

---

submit()

submit(jobSpec, shouldNotStart?): Promise<default>

Parameters

Parameter	Type
jobSpec	JobConfigParams
shouldNotStart?	boolean

Returns

Promise<default>

Source

jobs.ts:14

---

wrap()

wrap(jobId): default

Wraps the job_id with convenience functions for accessing the state on the server.

Parameters

Parameter	Type
jobId	string

Returns

default

Source

jobs.ts:39