Home Manual Reference Source
public class | source

JobResult

Extends:

ResourceBase → JobResult

Direct Subclass:

JobMonitorRow

Static Member Summary

Static Public Members
public static get
public static get

Member Summary

Public Members
public
public get

Get the related job

public get

Get the related job revision

public get

Job result log url

public get

Job result archive url

public get

Get the output url url

public get

Job result preview url, usable in an <img> tag

Method Summary

Public Methods
public

async dealWith(value: boolean, deleted: String)

Mark a job as dealt with This method is for internal use for our support team.

public

Download the job result log

public

Get archive blob url

public

Download the job preview

public

async getOutputUrl(deleted: String): Promise<string>

Get the remote output url

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

Protected read-only fields

public get

Get api instance

public set

api(value: Maps4News)

Set the api instance

public get

Auto generated Resource base url

public get

List fields that contain object data

public get

If the resource can be owned by an organisation

public get

url: string: *

Auto generated resource url

public

Clone the object

public

async refresh(updateSelf: Boolean): Promise<ResourceBase>

Refresh the resource by requesting it from the server again

public

reset(fields: Array<string> | string | null)

Resets model instance to it's original state

public

Clean up instance and commit all changes locally.

public

static(Target: string | function, Constructor: function, seedData: Object<string, *>): SimpleResourceProxy

Static proxy generation

public

toObject(camelCaseKeys: boolean): {}

Transform instance to object

public

String representation of the resource, similar to Python's repr

protected

Macro for resource listing

protected

Moves new fields to this._properties and turns them into a getter/setter

Static Public Members

public static get resourceName: string source

Resource name

Override:

ResourceBase#resourceName

public static get resourcePath: string source

Resource path template

Override:

ResourceBase#resourcePath

Public Members

public dealtWith: * source

public get job: Promise<Job, ApiError>: * source

Get the related job

Return:

Promise<Job, ApiError>

The job related to this row

public get jobRevision: Promise<JobRevision, ApiError>: * source

Get the related job revision

Return:

Promise<JobRevision, ApiError>

The job revision related to this row

public get logUrl: string: string source

Job result log url

Return:

string

log url

public get outputUrl: string: string source

Job result archive url

Return:

string

Archive url

public get outputUrlUrl: string: string source

Get the output url url

Return:

string

Output url url

public get previewUrl: string: string source

Job result preview url, usable in an <img> tag

Return:

string

Preview url

Public Methods

public async dealWith(value: boolean, deleted: String) source

Mark a job as dealt with This method is for internal use for our support team.

Params:

NameTypeAttributeDescription
value boolean
  • optional
  • default: true

What to set the dealt-with value to

deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

public async downloadLog(deleted: String): Promise<DownloadedResource> source

Download the job result log

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<DownloadedResource>

job result log

public async downloadOutput(deleted: String): Promise<DownloadedResource> source

Get archive blob url

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<DownloadedResource>

Job result output

public async downloadPreview(deleted: String): Promise<DownloadedResource> source

Download the job preview

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<DownloadedResource>

Job result preview

public async getOutputUrl(deleted: String): Promise<string> source

Get the remote output url

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<string>

The url to the output

Throw:

ApiError