Class SecurityPolicyBuilder

constructor

• new SecurityPolicyBuilder(): SecurityPolicyBuilder

• Returns SecurityPolicyBuilder

Optional aggregations

Optional locationPrecisions

Optional minAggregation

Optional minLocationPrecision

Optional nodeIds

Optional nodeMetadataPaths

Optional sourceIds

Optional userMetadataPaths

addAggregations

• addAggregations(aggregations?): SecurityPolicyBuilder

• Set the aggregations.

  Parameters

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

    the aggregations to add

  Returns SecurityPolicyBuilder

  this object

addLocationPrecisions

• addLocationPrecisions(locationPrecisions?): SecurityPolicyBuilder

• Add location precisions.

  Parameters

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

    the precisions to add

  Returns SecurityPolicyBuilder

  this object

addNodeIds

• addNodeIds(nodeIds?): SecurityPolicyBuilder

• Add a set of node IDs.

  Parameters

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

    the node IDs to add

  Returns SecurityPolicyBuilder

  this object

addNodeMetadataPaths

• addNodeMetadataPaths(nodeMetadataPaths?): SecurityPolicyBuilder

• Add a set of node metadata paths.

  Parameters

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

    the path expressions to add

  Returns SecurityPolicyBuilder

  this object

addPolicy

• addPolicy(policy?): SecurityPolicyBuilder

• Merge all properties from another SecurityPolicy.

  Parameters

  • Optional policy: SecurityPolicy

    the SecurityPolicy to merge

  Returns SecurityPolicyBuilder

  this object

addSourceIds

• addSourceIds(sourceIds?): SecurityPolicyBuilder

• Add source IDs.

  Parameters

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

    the source IDs to add

  Returns SecurityPolicyBuilder

  this object

addUserMetadataPaths

• addUserMetadataPaths(userMetadataPaths?): SecurityPolicyBuilder

• Add a set of user metadata paths.

  Parameters

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

    the path expressions to add

  Returns SecurityPolicyBuilder

  this object

build

• build(): SecurityPolicy

• Create a new SecurityPolicy out of the properties configured on this builder.

  Returns SecurityPolicy

  the new policy instance

withAggregations

• withAggregations(aggregations?): SecurityPolicyBuilder

• Set the aggregations.

  Parameters

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

    the aggregations to use

  Returns SecurityPolicyBuilder

  this object

withLocationPrecisions

• withLocationPrecisions(locationPrecisions?): SecurityPolicyBuilder

• Set the location precisions.

  Parameters

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

    the precisions to use

  Returns SecurityPolicyBuilder

  this object

withMinAggregation

• withMinAggregation(minAggregation?): SecurityPolicyBuilder

• Set a minimum aggregation level.

  Parameters

  • Optional minAggregation: Aggregation

    the minimum aggregation level to set

  Returns SecurityPolicyBuilder

  this object

withMinLocationPrecision

• withMinLocationPrecision(minLocationPrecision?): SecurityPolicyBuilder

• Treat the configured locationPrecisions set as a single minimum value or a list of exact values.

  By default if locationPrecisions is configured with a single value it will be treated as a minimum value, and any Domain.LocationPrecision with a Domain.LocationPrecision#precision equal to or higher than that value's level will be included in the generated Domain.SecurityPolicy#locationPrecisions set. Set this to undefined to disable that behavior and treat locationPrecisions as the exact values to include in the generated Domain.SecurityPolicy#locationPrecisions set.

  Parameters

  • Optional minLocationPrecision: LocationPrecision

    undefined to treat configured location precision values as-is, or else the minimum threshold

  Returns SecurityPolicyBuilder

  this object

withNodeIds

• withNodeIds(nodeIds?): SecurityPolicyBuilder

• Set the node IDs.

  Parameters

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

    the node IDs to use

  Returns SecurityPolicyBuilder

  this object

withNodeMetadataPaths

• withNodeMetadataPaths(nodeMetadataPaths?): SecurityPolicyBuilder

• Set the node metadata paths.

  Parameters

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

    the path expressions to use

  Returns SecurityPolicyBuilder

  this object

withPolicy

• withPolicy(policy?): SecurityPolicyBuilder

• Apply all properties from another SecurityPolicy.

  Parameters

  • Optional policy: SecurityPolicy

    the SecurityPolicy to apply

  Returns SecurityPolicyBuilder

  this object

withSourceIds

• withSourceIds(sourceIds?): SecurityPolicyBuilder

• Set the source IDs.

  Parameters

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

    the source IDs to use

  Returns SecurityPolicyBuilder

  this object

withUserMetadataPaths

• withUserMetadataPaths(userMetadataPaths?): SecurityPolicyBuilder

• Set the user metadata paths.

  Parameters

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

    the path expressions to use

  Returns SecurityPolicyBuilder

  this object