JobRequest

jobs~ JobRequest

Class encapsulating a job request for the API.

Constructor

new JobRequest(analytic)

Creates a new JobRequest instance.

Parameters:
Name Type Description
analytic string

the name of the analytic to run

Source:

Extends

Methods

setInput(name, path)

Sets the input of the given name.

Parameters:
Name Type Description
name string

the input name to set

path RemoteDataPath

a RemoteDataPath instance defining the path to the input data

Source:

setDataParameter(name, path)

Sets the data parameter of the given name.

Parameters:
Name Type Description
name string

the parameter name to set

path RemoteDataPath

a RemoteDataPath instance defining the path to the data for the parameter

Source:

setParameter(name, val)

Sets the (non-data) parameter of the given name.

Parameters:
Name Type Description
name string

the parameter name to set

val

the parameter vale, which must be JSON serializable

Source:

(static) fromObject(obj) → {JobRequest}

Constructs a JobRequest object from a JSON object representation of it.

Parameters:
Name Type Description
obj object

a JSON object representation of the JobRequest object

Source:

toObject() → {object}

Generates a JSON representation of the object.

Inherited From:
Source:

toString() → {string}

Generates a string representation of the Serializable object.

Inherited From:
Source:

toJSON(path)

Writes the object to disk in JSON format.

Parameters:
Name Type Description
path string

the output JSON file path. The base output directory is created, if necessary

Inherited From:
Source: