Class SecurityPolicyBuilder

constructor

• new SecurityPolicyBuilder(): SecurityPolicyBuilder

  Returns SecurityPolicyBuilder

Optionalaggregations

OptionallocationPrecisions

OptionalminAggregation

OptionalminLocationPrecision

OptionalnodeIds

OptionalnodeMetadataPaths

OptionalsourceIds

OptionaluserMetadataPaths

addAggregations

• addAggregations(
      aggregations?:
          | string
          | string[]
          | Aggregation
          | Aggregation[]
          | Set<string | Aggregation>,
  ): this

  Set the aggregations.

  Parameters

  • Optionalaggregations: string | string[] | Aggregation | Aggregation[] | Set<string | Aggregation>

    the aggregations to add

  Returns this

  this object

addLocationPrecisions

• addLocationPrecisions(
      locationPrecisions?:
          | string
          | string[]
          | LocationPrecision
          | LocationPrecision[]
          | Set<string | LocationPrecision>,
  ): this

  Add location precisions.

  Parameters

  • OptionallocationPrecisions:
        | string
        | string[]
        | LocationPrecision
        | LocationPrecision[]
        | Set<string | LocationPrecision>

    the precisions to add

  Returns this

  this object

addNodeIds

• addNodeIds(nodeIds?: number | number[] | Set<number>): this

  Add a set of node IDs.

  Parameters

  • OptionalnodeIds: number | number[] | Set<number>

    the node IDs to add

  Returns this

  this object

addNodeMetadataPaths

• addNodeMetadataPaths(nodeMetadataPaths?: string | string[] | Set<string>): this

  Add a set of node metadata paths.

  Parameters

  • OptionalnodeMetadataPaths: string | string[] | Set<string>

    the path expressions to add

  Returns this

  this object

addPolicy

• addPolicy(policy?: SecurityPolicy): this

  Merge all properties from another SecurityPolicy.

  Parameters

  • Optionalpolicy: SecurityPolicy

    the SecurityPolicy to merge

  Returns this

  this object

addSourceIds

• addSourceIds(sourceIds?: string | string[] | Set<string>): this

  Add source IDs.

  Parameters

  • OptionalsourceIds: string | string[] | Set<string>

    the source IDs to add

  Returns this

  this object

addUserMetadataPaths

• addUserMetadataPaths(userMetadataPaths?: string | string[] | Set<string>): this

  Add a set of user metadata paths.

  Parameters

  • OptionaluserMetadataPaths: string | string[] | Set<string>

    the path expressions to add

  Returns this

  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?:
          | string
          | string[]
          | Aggregation
          | Aggregation[]
          | Set<string | Aggregation>,
  ): this

  Set the aggregations.

  Parameters

  • Optionalaggregations: string | string[] | Aggregation | Aggregation[] | Set<string | Aggregation>

    the aggregations to use

  Returns this

  this object

withLocationPrecisions

• withLocationPrecisions(
      locationPrecisions?:
          | string
          | string[]
          | LocationPrecision
          | LocationPrecision[]
          | Set<string | LocationPrecision>,
  ): this

  Set the location precisions.

  Parameters

  • OptionallocationPrecisions:
        | string
        | string[]
        | LocationPrecision
        | LocationPrecision[]
        | Set<string | LocationPrecision>

    the precisions to use

  Returns this

  this object

withMinAggregation

• withMinAggregation(minAggregation?: string | Aggregation): this

  Set a minimum aggregation level.

  Parameters

  • OptionalminAggregation: string | Aggregation

    the minimum aggregation level to set

  Returns this

  this object

withMinLocationPrecision

• withMinLocationPrecision(
      minLocationPrecision?: string | LocationPrecision,
  ): this

  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

  • OptionalminLocationPrecision: string | LocationPrecision

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

  Returns this

  this object

withNodeIds

• withNodeIds(nodeIds?: number | number[] | Set<number>): this

  Set the node IDs.

  Parameters

  • OptionalnodeIds: number | number[] | Set<number>

    the node IDs to use

  Returns this

  this object

withNodeMetadataPaths

• withNodeMetadataPaths(nodeMetadataPaths?: string | string[] | Set<string>): this

  Set the node metadata paths.

  Parameters

  • OptionalnodeMetadataPaths: string | string[] | Set<string>

    the path expressions to use

  Returns this

  this object

withPolicy

• withPolicy(policy?: SecurityPolicy): this

  Apply all properties from another SecurityPolicy.

  Parameters

  • Optionalpolicy: SecurityPolicy

    the SecurityPolicy to apply

  Returns this

  this object

withSourceIds

• withSourceIds(sourceIds?: string | string[] | Set<string>): this

  Set the source IDs.

  Parameters

  • OptionalsourceIds: string | string[] | Set<string>

    the source IDs to use

  Returns this

  this object

withUserMetadataPaths

• withUserMetadataPaths(userMetadataPaths?: string | string[] | Set<string>): this

  Set the user metadata paths.

  Parameters

  • OptionaluserMetadataPaths: string | string[] | Set<string>

    the path expressions to use

  Returns this

  this object