Job
Extends:
Static Member Summary
Static Public Members | ||
public static get abstract |
Resource name |
Member Summary
Public Members | ||
public get |
Get the most up to date archive url |
|
public get |
Get the most up to date preview url |
|
public get |
Get the list of associated job results |
|
public get |
Get the list job revisions |
Method Summary
Public Methods | ||
public |
downloadOutput(deleted: String): CancelablePromise<DownloadedResource> Get archive blob url |
|
public |
downloadPreview(deleted: String): CancelablePromise<DownloadedResource> Download the job preview |
|
public |
getOutputUrl(deleted: String): CancelablePromise<string> Get the remote output url |
|
public |
share(visibility: String, deleted: String): CancelablePromise<JobShare> Share the job |
Inherited Summary
From class ResourceBase | ||
public static get |
Returns if the resource is readonly |
|
public static get abstract |
Resource name |
|
public static get |
Resource path template |
|
public static get |
Returns the url key of the resource |
|
protected static get |
protectedFields: Array<string>: string[] Protected read-only fields |
|
public get |
api: Mapcreator: * Get api instance |
|
public set |
api(value: Mapcreator) Set the api instance |
|
public get |
Auto generated Resource base url |
|
public get |
fieldNames: Array<String>: * List fields that contain object data |
|
public get |
If the resource can be owned by an organisation |
|
public get |
Auto generated resource url |
|
public |
Clone the object |
|
public |
refresh(updateSelf: Boolean): CancelablePromise<ResourceBase> Refresh the resource by requesting it from the server again |
|
public |
Resets model instance to it's original state |
|
public |
sanitize() Clean up instance and commit all changes locally. |
|
public |
static(Target: string | Class, Constructor: Class?, seedData: Object<string, *>): SimpleResourceProxy Static proxy generation |
|
public |
Transform instance to object |
|
public |
String representation of the resource, similar to Python's repr |
|
protected |
_guessType(name: string, value: *): * Guess type based on property name |
|
protected |
_proxyResourceList(Target: string | Class<ResourceBase>, url: String, seedData: object): SimpleResourceProxy Macro for resource listing |
|
protected |
Moves new fields to this._properties and turns them into a getter/setter |
From class CrudBase | ||
public |
delete(updateSelf: Boolean): CancelablePromise<CrudBase> Delete item |
|
public |
restore(updateSelf: Boolean): CancelablePromise<CrudBase> Restore item |
|
public |
Save item. |
|
protected |
_buildCreateData(): Object<String, *> Build data for create operation |
|
protected |
Update existing item |
Static Public Members
public static get abstract resourceName: String: string source
Resource name
Override:
ResourceBase#resourceNamePublic Members
Public Methods
public downloadOutput(deleted: String): CancelablePromise<DownloadedResource> source
Get archive blob url
Params:
Name | Type | Attribute | Description |
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |
public downloadPreview(deleted: String): CancelablePromise<DownloadedResource> source
Download the job preview
Params:
Name | Type | Attribute | Description |
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |
public getOutputUrl(deleted: String): CancelablePromise<string> source
Get the remote output url
Params:
Name | Type | Attribute | Description |
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |
public share(visibility: String, deleted: String): CancelablePromise<JobShare> source
Share the job
Params:
Name | Type | Attribute | Description |
visibility | String | See JobShareVisibility, either |
|
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |