domain~ SecurityPolicy

An immutable set of security restrictions that can be attached to other objects, like auth tokens.

Use the module:domain~SecurityPolicyBuilder to create instances of this class with a fluent API.

Constructor

new SecurityPolicy(nodeIdsopt, sourceIdsopt, aggregationsopt, minAggregationopt, locationPrecisionsopt, minLocationPrecisionopt, nodeMetadataPathsopt, userMetadataPathsopt)

Constructor.

Parameters:
NameTypeAttributesDescription
nodeIdsArray.<number> | Set.<number><optional>

the node IDs to restrict to, or null for no restriction

sourceIdsArray.<string> | Set.<string><optional>

the source ID to restrict to, or null for no restriction

aggregationsArray.<module:domain~Aggregation> | Set.<module:domain~Aggregation><optional>

the aggregation names to restrict to, or null for no restriction

minAggregationmodule:domain~Aggregation<optional>

if specified, a minimum aggregation level that is allowed

locationPrecisionsSet.<module:domain~LocationPrecision><optional>

the location precision names to restrict to, or null for no restriction

minLocationPrecisionmodule:domain~LocationPrecision<optional>

if specified, a minimum location precision that is allowed

nodeMetadataPathsSet.<string><optional>

the SolarNodeMetadata paths to restrict to, or null for no restriction

userMetadataPathsSet.<string><optional>

the UserNodeMetadata paths to restrict to, or null for no restriction

Source

Members

aggregations

Get the aggregations.

Source

locationPrecisions

Get the location precisions.

Source

minAggregation

Get the minimum aggregation.

Source

minLocationPrecision

Get the minimum location precision.

Source

nodeIds

Get the node IDs.

Source

nodeMetadataPaths

Get the node metadata paths.

Source

sourceIds

Get the source IDs.

Source

userMetadataPaths

Get the user metadata paths.

Source

Methods

toJsonEncoding() → {string}

Get this object as a standard JSON encoded string value.

Source
Returns:

the JSON encoded string

Type: 
string