SolarNode Image Maker

Class: SolarNodeImageOptions

domain~ SolarNodeImageOptions

A NIM options object.

new SolarNodeImageOptions(environment, parameters, verbose)

Constructor.

Parameters:
Name Type Description
environment object

environment parameters to pass to the customization process
parameters object

parameters to pass to the customization process
verbose boolean

true to output verbose information during the customization process

Members

environment :object

Environment parameters to pass to the customization process.

The keys and values will be treated as strings.

Type:
  • object

parameters :object

Parameters to pass to the customization process.

Type:
  • object

verbose :boolean

A flag to toggle producing verbose information during the customization process.

Type:
  • boolean

Methods

<static> fromJsonEncoding(json)

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

The JSON must be encoded the same way module:domain~SolarNodeImageOptions#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~SolarNodeImageOptions

toJsonEncoding()

Get this object as a standard JSON encoded string value.

Returns:

the JSON encoded string

Type
string