Teraslice Client (JavaScript): `Executions Default`
executions.default
Hierarchy
-
↳
default
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new default(config
): default
Parameters
Name | Type |
---|---|
config | ClientConfig |
Returns
Overrides
Defined in
Properties
_config
• Protected
Readonly
_config: ClientConfig
Inherited from
Defined in
Methods
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(exId?
, opts?
): Promise
<ErrorRecord
[]>
Parameters
Name | Type | |
---|---|---|
exId? | string \ | SearchQuery |
opts? | 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
list
▸ list(options?
): Promise
<ExecutionRecord
[]>
Parameters
Name | Type |
---|---|
options? | ListOptions |
Returns
Promise
<ExecutionRecord
[]>
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
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
submit
▸ submit(jobSpec
, shouldNotStart?
): Promise
<default
>
Similar to jobs.submit but returns an instance of Ex not a Job
Parameters
Name | Type |
---|---|
jobSpec | JobConfig |
shouldNotStart? | boolean |
Returns
Promise
<default
>
Defined in
wrap
▸ wrap(exId
): default
Wraps the execution id with convenience functions for accessing the state on the server.
Parameters
Name | Type |
---|---|
exId | string |