Job

Job

Class that manages info and execution of a particular job

Constructor

new Job(name, run, config)

Source:
Parameters:
Name Type Description
name string
run string | undefined
config any

Members

config

Source:

customer

Source:

key

Source:

key

Source:

name

Source:

processedCount

Source:

records

Source:

records

Source:

rerun

Source:

rerun

Sets the rerun flag

Source:

results

Source:

run :string

The run name

Source:
Type:
  • string

run

Source:

status

Source:

timestamp :string

The date the job was created (UTC) Saved in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Eg. 2020-05-21T15:50:13Z

Source:
Type:
  • string

Methods

(static) fromJSON(json) → {Job}

Creates a new Job object from JSON

Source:
Parameters:
Name Type Description
json Object
Returns:
Type:
Job

(async, static) lazyFetchJobForKey(key) → {Promise.<Job>}

This routine loads a Job It checks first for it locally - if it's not there, it loads it remotely It then saves it locally for faster access

Source:
Parameters:
Name Type Description
key string
Returns:
Type:
Promise.<Job>

addProcessedCount(countopt) → {void}

Increments the number of records being processed

Source:
Parameters:
Name Type Attributes Default Description
count number <optional>
1

Defaults to 1

Returns:
Type:
void

addResult(result) → {void}

Captures a result of a record being processed

Source:
Parameters:
Name Type Description
result Result
Returns:
Type:
void

expectedFieldNames() → {Array.<string>}

Iterates across all the results to see all the expected field values

Source:
Returns:
Type:
Array.<string>

Return the list of expected field names

logURL(index) → {string}

Source:
Parameters:
Name Type Description
index number
Returns:
Type:
string

outputFieldNames() → {Array.<string>}

Source:
Returns:
Type:
Array.<string>

toJSON() → {any}

Source:
Returns:
Type:
any