Teraslice Client (JavaScript): `Ex Default`
ex.default
Hierarchy
-
↳
default
Table of contents
Constructors
Properties
Methods
- changeWorkers
- config
- controller
- delete
- errors
- get
- id
- makeOptions
- parse
- pause
- post
- put
- recover
- resume
- slicer
- status
- stop
- waitForStatus
- workers
Constructors
constructor
• new default(config
, exId
): default
Parameters
Name | Type |
---|---|
config | ClientConfig |
exId | string |
Returns
Overrides
Defined in
Properties
_config
• Protected
Readonly
_config: ClientConfig
Inherited from
Defined in
Methods
changeWorkers
▸ changeWorkers(action
, workerNum
, requestOptions?
): Promise
<string
| ChangeWorkerResponse
>
Parameters
Name | Type |
---|---|
action | ChangeWorkerQueryParams |
workerNum | number |
requestOptions | Options |
Returns
Promise
<string
| ChangeWorkerResponse
>
Defined in
config
▸ config(requestOptions?
): Promise
<ExecutionRecord
>
Parameters
Name | Type |
---|---|
requestOptions | Options |
Returns
Promise
<ExecutionRecord
>
Defined in
controller
▸ controller(requestOptions?
): Promise
<ExecutionList
>
Parameters
Name | Type |
---|---|
requestOptions | Options |
Returns
Promise
<ExecutionList
>
Defined in
delete
▸ delete<T
>(endpoint
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
options? | SearchOptions |
Returns
Promise
<T
>
Inherited from
Defined in
errors
▸ errors(options?
): Promise
<ErrorRecord
[]>
Parameters
Name | Type |
---|---|
options? | SearchQuery |
Returns
Promise
<ErrorRecord
[]>
Defined in
get
▸ get<T
>(endpoint
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
options? | SearchOptions |
Returns
Promise
<T
>
Inherited from
Defined in
id
▸ id(): string
Returns
string
Defined in
makeOptions
▸ makeOptions(searchParams
, options
): Options
Parameters
Name | Type | |
---|---|---|
searchParams | undefined \ | Record <string , any > |
options | Options \ | SearchOptions |
Returns
Options
Inherited from
Defined in
parse
▸ parse(results
): any
Parameters
Name | Type |
---|---|
results | unknown |
Returns
any
Inherited from
Defined in
pause
▸ pause(query?
, searchOptions?
): Promise
<ApiPausedResponse
>
Parameters
Name | Type |
---|---|
query? | SearchQuery |
searchOptions | SearchOptions |
Returns
Promise
<ApiPausedResponse
>
Defined in
post
▸ post<T
>(endpoint
, data?
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
data? | unknown |
options? | Options |
Returns
Promise
<T
>
Inherited from
Defined in
put
▸ put<T
>(endpoint
, data
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
data | unknown |
options? | Options |
Returns
Promise
<T
>
Inherited from
Defined in
recover
▸ recover(query?
, searchOptions?
): Promise
<default
>
Parameters
Name | Type |
---|---|
query | RecoverQuery |
searchOptions | SearchOptions |
Returns
Promise
<default
>
Defined in
resume
▸ resume(query?
, searchOptions?
): Promise
<ApiResumeResponse
>
Parameters
Name | Type |
---|---|
query? | SearchQuery |
searchOptions | SearchOptions |
Returns
Promise
<ApiResumeResponse
>
Defined in
slicer
▸ slicer(requestOptions?
): Promise
<ExecutionList
>
Parameters
Name | Type |
---|---|
requestOptions | Options |
Returns
Promise
<ExecutionList
>
Defined in
status
▸ status(requestOptions?
): Promise
<"pending"
| "scheduling"
| "initializing"
| "running"
| "recovering"
| "failing"
| "paused"
| "stopping"
| "completed"
| "stopped"
| "rejected"
| "failed"
| "terminated"
>
Parameters
Name | Type |
---|---|
requestOptions? | Options |
Returns
Promise
<"pending"
| "scheduling"
| "initializing"
| "running"
| "recovering"
| "failing"
| "paused"
| "stopping"
| "completed"
| "stopped"
| "rejected"
| "failed"
| "terminated"
>
Defined in
stop
▸ stop(query?
, searchOptions?
): Promise
<ApiStoppedResponse
>
Parameters
Name | Type |
---|---|
query? | StopQuery |
searchOptions | SearchOptions |
Returns
Promise
<ApiStoppedResponse
>
Defined in
waitForStatus
▸ waitForStatus(target
, intervalMs?
, timeoutMs?
, requestOptions?
): Promise
<"pending"
| "scheduling"
| "initializing"
| "running"
| "recovering"
| "failing"
| "paused"
| "stopping"
| "completed"
| "stopped"
| "rejected"
| "failed"
| "terminated"
>
Parameters
Name | 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 | Options | {} |
Returns
Promise
<"pending"
| "scheduling"
| "initializing"
| "running"
| "recovering"
| "failing"
| "paused"
| "stopping"
| "completed"
| "stopped"
| "rejected"
| "failed"
| "terminated"
>
Defined in
workers
▸ workers(requestOptions?
): Promise
<WorkerNode
[]>
Parameters
Name | Type |
---|---|
requestOptions | Options |
Returns
Promise
<WorkerNode
[]>