Class: SecurityPolicy

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.


new SecurityPolicy( [nodeIds] [, sourceIds] [, aggregations] [, minAggregation] [, locationPrecisions] [, minLocationPrecision] [, nodeMetadataPaths] [, userMetadataPaths])

Constructor.

Parameters:
Name Type Argument Description
nodeIds Array.<number> | Set.<number> <optional>

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

sourceIds Array.<string> | Set.<string> <optional>

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

aggregations Array.<module:domain~Aggregation> | Set.<module:domain~Aggregation> <optional>

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

minAggregation module:domain~Aggregation <optional>

if specified, a minimum aggregation level that is allowed

locationPrecisions Set.<module:domain~LocationPrecision> <optional>

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

minLocationPrecision module:domain~LocationPrecision <optional>

if specified, a minimum location precision that is allowed

nodeMetadataPaths Set.<string> <optional>

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

userMetadataPaths Set.<string> <optional>

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

Members


aggregations

Get the aggregations.


locationPrecisions

Get the location precisions.


minAggregation

Get the minimum aggregation.


minLocationPrecision

Get the minimum location precision.


nodeIds

Get the node IDs.


nodeMetadataPaths

Get the node metadata paths.


sourceIds

Get the source IDs.


userMetadataPaths

Get the user metadata paths.

Methods


toJsonEncoding()

Get this object as a standard JSON encoded string value.

Returns:

the JSON encoded string

Type
string