new SecurityPolicyBuilder()
Methods
-
addAggregations(aggregations)
-
Set the aggregations.
Parameters:
Name Type Description aggregations
Array.<module:domain~Aggregation> | Set.<module:domain~Aggregation> the aggregations to add
Returns:
this object
-
addLocationPrecisions(locationPrecisions)
-
Add location precisions.
Parameters:
Name Type Description locationPrecisions
Array.<module:domain~LocationPrecision> | Set.<module:domain~LocationPrecision> the precisions to add
Returns:
this object
-
addNodeIds(nodeIds)
-
Add a set of node IDs.
Parameters:
Name Type Description nodeIds
Array.<number> | Set.<number> the node IDs to add
Returns:
this object
-
addNodeMetadataPaths(nodeMetadataPaths)
-
Add a set of node metadata paths.
Parameters:
Name Type Description nodeMetadataPaths
Array.<string> | Set.<string> the path expressions to add
Returns:
this object
-
addPolicy(policy)
-
Merge all properties from another SecurityPolicy.
Parameters:
Name Type Description policy
module:domain~SecurityPolicy the SecurityPolicy to merge
Returns:
this object
-
addSourceIds(sourceIds)
-
Add source IDs.
Parameters:
Name Type Description sourceIds
Array.<string> | Set.<string> the source IDs to add
Returns:
this object
-
addUserMetadataPaths(userMetadataPaths)
-
Add a set of user metadata paths.
Parameters:
Name Type Description userMetadataPaths
Array.<string> | Set.<string> the path expressions to add
Returns:
this object
-
build()
-
Create a new SecurityPolicy out of the properties configured on this builder.
Returns:
the new policy instance
-
withAggregations(aggregations)
-
Set the aggregations.
Parameters:
Name Type Description aggregations
Array.<module:domain~Aggregation> | Set.<module:domain~Aggregation> the aggregations to use
Returns:
this object
-
withLocationPrecisions(locationPrecisions)
-
Set the location precisions.
Parameters:
Name Type Description locationPrecisions
Array.<module:domain~LocationPrecision> | Set.<module:domain~LocationPrecision> the precisions to use
Returns:
this object
-
withMinAggregation(minAggregation)
-
Set a minimum aggregation level.
Parameters:
Name Type Description minAggregation
module:domain~Aggregation the minimum aggregation level to set
Returns:
this object
-
withMinLocationPrecision(minLocationPrecision)
-
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 module:domain~LocationPrecision with a module:domain~LocationPrecision#precision equal to or higher than that value's level will be included in the generated module:domain~SecurityPolicy#locationPrecisions set. Set this tonull
to disable that behavior and treatlocationPrecisions
as the exact values to include in the generated module:domain~SecurityPolicy#locationPrecisions set.Parameters:
Name Type Description minLocationPrecision
module:domain~LocationPrecision | null null
to treat configured location precision values as-is, or else the minimum thresholdReturns:
this object
-
withNodeIds(nodeIds)
-
Set the node IDs.
Parameters:
Name Type Description nodeIds
Array.<number> | Set.<number> the node IDs to use
Returns:
this object
-
withNodeMetadataPaths(nodeMetadataPaths)
-
Set the node metadata paths.
Parameters:
Name Type Description nodeMetadataPaths
Array.<string> | Set.<string> the path expressions to use
Returns:
this object
-
withPolicy(policy)
-
Apply all properties from another SecurityPolicy.
Parameters:
Name Type Description policy
module:domain~SecurityPolicy the SecurityPolicy to apply
Returns:
this object
-
withSourceIds(sourceIds)
-
Set the source IDs.
Parameters:
Name Type Description sourceIds
Array.<string> | Set.<string> the source IDs to use
Returns:
this object
-
withUserMetadataPaths(userMetadataPaths)
-
Set the user metadata paths.
Parameters:
Name Type Description userMetadataPaths
Array.<string> | Set.<string> the path expressions to use
Returns:
this object