SolarNode Image Maker

Class: SolarNodeImageReceipt

domain~ SolarNodeImageReceipt

An immutable NIM receipt object.

new SolarNodeImageReceipt(id, baseImageId, createdDate, started, done, cancelled, percentComplete, message [, startedDate] [, completedDate] [, imageInfo] [, downloadUrl])

Constructor.

Parameters:
Name Type Argument Description
id string

a unique ID for this work task
baseImageId string

the ID of the image that served as the starting point for this customized image
createdDate Date

the date the task was created
started boolean

flag indicating if the task has started executing
done boolean

flag indicating if the task has completed executing
cancelled boolean

flag indicating if the task was cancelled before executing completely
percentComplete number

the amount of work that has been completed, as a fractional percentage between 0 and 1
message string

a status message
startedDate Date <optional>

the date the customization task started executing
completedDate Date <optional>

the date the customization task completed executing
imageInfo SolarNodeImageInfo <optional>

information about the final image, once ready
downloadUrl string <optional>

a URL for a direct download of the finished image

Members

<readonly> baseImageId :string

The ID of the image that served as the starting point for this customized image.

Type:
  • string

<readonly> cancelled :boolean

A flag indicating if the task task was cancelled before executing completely.

Type:
  • boolean

<readonly> completedDate :Date

The date the customization task completed executing.

Type:
  • Date

<readonly> createdDate :Date

The date the task was created.

Type:
  • Date

<readonly> done :boolean

A flag indicating if the task has completed executing.

Type:
  • boolean

<readonly> downloadUrl :string

A URL for a direct download of the finished image.

Type:
  • string

<readonly> id :string

A unique ID for this work task.

Type:
  • string

<readonly> imageInfo :SolarNodeImageInfo

Information about the final image, once ready.

Type:
  • SolarNodeImageInfo

<readonly> message :string

A status message.

Type:
  • string

<readonly> percentComplete :number

The amount of work that has been completed, as a fractional percentage between 0 and 1.

Type:
  • number

<readonly> started :boolean

A flag indicating if the task has started executing.

Type:
  • boolean

<readonly> startedDate :Date

The date the customization task started executing.

Type:
  • Date

Methods

<static> fromJsonEncoding(json)

Parse a JSON string into a module:domain~SolarNodeImageReceipt instance.

The JSON must be encoded the same way module:domain~SolarNodeImageReceipt#toJsonEncoding does.

Parameters:
Name Type Description
json string | Object

the JSON to parse, or a parsed JSON object
Returns:

the session instance

Type
module:domain~SolarNodeImageReceipt

toJsonEncoding()

Get this object as a standard JSON encoded string value.

Returns:

the JSON encoded string

Type
string