Class SecurityPolicy

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

Use the Domain.SecurityPolicyBuilder to create instances of this class with a fluent API.

Hierarchy

  • SecurityPolicy

Constructors

constructor

Properties

#aggregations? #locationPrecisions? #minAggregation? #minLocationPrecision? #nodeIds? #nodeMetadataPaths? #sourceIds? #userMetadataPaths?

Accessors

aggregations locationPrecisions minAggregation minLocationPrecision nodeIds nodeMetadataPaths sourceIds userMetadataPaths

Methods

toJsonEncoding

Constructors

constructor

  • Constructor.

    Parameters

    • Optional nodeIds: number[] | Set<number>

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

    • Optional sourceIds: string[] | Set<string>

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

    • Optional aggregations: Aggregation[] | Set<Aggregation>

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

    • Optional minAggregation: Aggregation

      if specified, a minimum aggregation level that is allowed

    • Optional locationPrecisions: LocationPrecision[] | Set<LocationPrecision>

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

    • Optional minLocationPrecision: LocationPrecision

      if specified, a minimum location precision that is allowed

    • Optional nodeMetadataPaths: string[] | Set<string>

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

    • Optional userMetadataPaths: string[] | Set<string>

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

    Returns SecurityPolicy

Properties

Private Optional Readonly #aggregations

#aggregations?: Set<Aggregation>

Private Optional Readonly #locationPrecisions

#locationPrecisions?: Set<LocationPrecision>

Private Optional Readonly #minAggregation

#minAggregation?: Aggregation

Private Optional Readonly #minLocationPrecision

#minLocationPrecision?: LocationPrecision

Private Optional Readonly #nodeIds

#nodeIds?: Set<number>

Private Optional Readonly #nodeMetadataPaths

#nodeMetadataPaths?: Set<string>

Private Optional Readonly #sourceIds

#sourceIds?: Set<string>

Private Optional Readonly #userMetadataPaths

#userMetadataPaths?: Set<string>

Accessors

aggregations

locationPrecisions

minAggregation

minLocationPrecision

nodeIds

nodeMetadataPaths

  • get nodeMetadataPaths(): undefined | Set<string>

  • Get the node metadata paths.

    Returns undefined | Set<string>

    the node metadata paths, or undefined

sourceIds

userMetadataPaths

  • get userMetadataPaths(): undefined | Set<string>

  • Get the user metadata paths.

    Returns undefined | Set<string>

    the user metadata paths, or undefined

Methods

toJsonEncoding

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc