domain~ SecurityPolicyBuilder

A mutable builder object for module:domain~SecurityPolicy instances.

Constructor

new SecurityPolicyBuilder()

Methods

addAggregations(aggregations) → {module:domain~SecurityPolicyBuilder}

Set the aggregations.

Parameters:
NameTypeDescription
aggregationsArray.<module:domain~Aggregation> | Set.<module:domain~Aggregation>

the aggregations to add

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

addLocationPrecisions(locationPrecisions) → {module:domain~SecurityPolicyBuilder}

Add location precisions.

Parameters:
NameTypeDescription
locationPrecisionsArray.<module:domain~LocationPrecision> | Set.<module:domain~LocationPrecision>

the precisions to add

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

addNodeIds(nodeIds) → {module:domain~SecurityPolicyBuilder}

Add a set of node IDs.

Parameters:
NameTypeDescription
nodeIdsArray.<number> | Set.<number>

the node IDs to add

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

addNodeMetadataPaths(nodeMetadataPaths) → {module:domain~SecurityPolicyBuilder}

Add a set of node metadata paths.

Parameters:
NameTypeDescription
nodeMetadataPathsArray.<string> | Set.<string>

the path expressions to add

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

addPolicy(policy) → {module:domain~SecurityPolicyBuilder}

Merge all properties from another SecurityPolicy.

Parameters:
NameTypeDescription
policymodule:domain~SecurityPolicy

the SecurityPolicy to merge

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

addSourceIds(sourceIds) → {module:domain~SecurityPolicyBuilder}

Add source IDs.

Parameters:
NameTypeDescription
sourceIdsArray.<string> | Set.<string>

the source IDs to add

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

addUserMetadataPaths(userMetadataPaths) → {module:domain~SecurityPolicyBuilder}

Add a set of user metadata paths.

Parameters:
NameTypeDescription
userMetadataPathsArray.<string> | Set.<string>

the path expressions to add

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

build() → {module:domain~SecurityPolicy}

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

Returns:

the new policy instance

Type: 
module:domain~SecurityPolicy

withAggregations(aggregations) → {module:domain~SecurityPolicyBuilder}

Set the aggregations.

Parameters:
NameTypeDescription
aggregationsArray.<module:domain~Aggregation> | Set.<module:domain~Aggregation>

the aggregations to use

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withLocationPrecisions(locationPrecisions) → {module:domain~SecurityPolicyBuilder}

Set the location precisions.

Parameters:
NameTypeDescription
locationPrecisionsArray.<module:domain~LocationPrecision> | Set.<module:domain~LocationPrecision>

the precisions to use

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withMinAggregation(minAggregation) → {module:domain~SecurityPolicyBuilder}

Set a minimum aggregation level.

Parameters:
NameTypeDescription
minAggregationmodule:domain~Aggregation

the minimum aggregation level to set

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withMinLocationPrecision(minLocationPrecision) → {module:domain~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 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 to null to disable that behavior and treat locationPrecisions as the exact values to include in the generated module:domain~SecurityPolicy#locationPrecisions set.

Parameters:
NameTypeDescription
minLocationPrecisionmodule:domain~LocationPrecision | null

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

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withNodeIds(nodeIds) → {module:domain~SecurityPolicyBuilder}

Set the node IDs.

Parameters:
NameTypeDescription
nodeIdsArray.<number> | Set.<number>

the node IDs to use

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withNodeMetadataPaths(nodeMetadataPaths) → {module:domain~SecurityPolicyBuilder}

Set the node metadata paths.

Parameters:
NameTypeDescription
nodeMetadataPathsArray.<string> | Set.<string>

the path expressions to use

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withPolicy(policy) → {module:domain~SecurityPolicyBuilder}

Apply all properties from another SecurityPolicy.

Parameters:
NameTypeDescription
policymodule:domain~SecurityPolicy

the SecurityPolicy to apply

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withSourceIds(sourceIds) → {module:domain~SecurityPolicyBuilder}

Set the source IDs.

Parameters:
NameTypeDescription
sourceIdsArray.<string> | Set.<string>

the source IDs to use

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder

withUserMetadataPaths(userMetadataPaths) → {module:domain~SecurityPolicyBuilder}

Set the user metadata paths.

Parameters:
NameTypeDescription
userMetadataPathsArray.<string> | Set.<string>

the path expressions to use

Returns:

this object

Type: 
module:domain~SecurityPolicyBuilder