teraslice-client-js / jobs / default

Class: default

Defined in: jobs.ts:8

Extends

• default

Constructors

new default()

new default(config): default

Defined in: jobs.ts:9

Parameters

Parameter	Type
config	ClientConfig

Returns

default

Overrides

default.constructor

Properties

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

Methods

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

---

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

---

list()

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

Defined in: jobs.ts:28

Parameters

Parameter	Type
query?	JobSearchParams
searchOptions?	Partial

Returns

Promise<JobConfig[]>

---

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

---

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

---

submit()

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

Defined in: jobs.ts:14

Parameters

Parameter	Type
jobSpec	JobConfigParams
shouldNotStart?	boolean

Returns

Promise<default>

---

wrap()

wrap(jobId): default

Defined in: jobs.ts:39

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

Parameters

Parameter	Type
jobId	string

Returns

default