Policy
Policy declares a name, rule, and first-match evaluation semantic for an expression graph.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Policy(
sourceValue,sourceInfoValue):Policy
constructor configures the policy’s source and source information.
Parameters
Section titled “Parameters”sourceValue
Section titled “sourceValue”sourceInfoValue
Section titled “sourceInfoValue”SourceInfo
Returns
Section titled “Returns”Policy
Methods
Section titled “Methods”addImport()
Section titled “addImport()”addImport(
value):void
addImport adds an import to the policy.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
clearMetadata()
Section titled “clearMetadata()”clearMetadata(
name):void
clearMetadata removes a named metadata key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
description()
Section titled “description()”description():
ValueString
description returns the description of the policy.
Returns
Section titled “Returns”explanationOutputPolicy()
Section titled “explanationOutputPolicy()”explanationOutputPolicy():
Policy
explanationOutputPolicy returns a copy whose match outputs use explanation expressions.
Returns
Section titled “Returns”Policy
imports()
Section titled “imports()”imports():
Import[]
imports returns the list of imports associated with the policy.
Returns
Section titled “Returns”Import[]
metadata()
Section titled “metadata()”metadata(
name): [unknown,boolean]
metadata returns a named metadata object when it exists.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”[unknown, boolean]
metadataKeys()
Section titled “metadataKeys()”metadataKeys():
string[]
metadataKeys returns the metadata keys set on the policy.
Returns
Section titled “Returns”string[]
name()
Section titled “name()”name():
ValueString
name returns the name of the policy.
Returns
Section titled “Returns”rule()
Section titled “rule()”rule():
Rule|undefined
rule returns the rule entry point of the policy.
Returns
Section titled “Returns”Rule | undefined
setDescription()
Section titled “setDescription()”setDescription(
value):void
setDescription configures the policy description.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setMetadata()
Section titled “setMetadata()”setMetadata(
name,value):void
setMetadata updates a named metadata key.
Parameters
Section titled “Parameters”string
unknown
Returns
Section titled “Returns”void
setName()
Section titled “setName()”setName(
value):void
setName configures the policy name.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setRule()
Section titled “setRule()”setRule(
value):void
setRule configures the policy rule entry point.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
source()
Section titled “source()”source():
Source
source returns the policy file contents as a CEL source object.
Returns
Section titled “Returns”sourceInfo()
Section titled “sourceInfo()”sourceInfo():
SourceInfo
sourceInfo returns metadata about expression positions in the policy file.
Returns
Section titled “Returns”SourceInfo