pii

Type Members

1. type ApplyStrategyFn = (String, PiiStrategy) ⇒ (String, ModifiedFields)

   

2. type DigestFunction = (Array[Byte]) ⇒ String

   

3. sealed trait ModifiedField extends AnyRef

   

   The modified field trait represents an item that is transformed in either the JSON or a scalar mutators.

4. type ModifiedFields = List[ModifiedField]

   

5. type MutatorFn = (EnrichedEvent, PiiStrategy, ApplyStrategyFn) ⇒ ModifiedFields

   

6. final case class PiiJson(fieldMutator: Mutator, schemaCriterion: SchemaCriterion, jsonPath: String) extends PiiField with Product with Serializable

   

   Specifies a strategy to use, a field mutator where the JSON can be found in the EnrichedEvent POJO, a schema criterion to discriminate which contexts to apply this strategy to, and a JSON path within the contexts where this strategy will be applied (the path may correspond to multiple fields).

   Specifies a strategy to use, a field mutator where the JSON can be found in the EnrichedEvent POJO, a schema criterion to discriminate which contexts to apply this strategy to, and a JSON path within the contexts where this strategy will be applied (the path may correspond to multiple fields).

   fieldMutator

   the field mutator for the JSON field

   schemaCriterion

   the schema for which the strategy will be applied

   jsonPath

   the path where the strategy will be applied

7. case class PiiPseudonymizerEnrichment(fieldList: List[PiiField], emitIdentificationEvent: Boolean, strategy: PiiStrategy) extends Enrichment with Product with Serializable

   

   The PiiPseudonymizerEnrichment runs after all other enrichments to find fields that are configured as PII (personally identifiable information) and apply some anonymization (currently only pseudonymization) on them.

   The PiiPseudonymizerEnrichment runs after all other enrichments to find fields that are configured as PII (personally identifiable information) and apply some anonymization (currently only pseudonymization) on them. Currently a single strategy for all the fields is supported due to the configuration format, and there is only one implemented strategy, however the enrichment supports a strategy per field.

   The user may specify two types of fields in the config pojo or json. A pojo field is effectively a scalar field in the EnrichedEvent, whereas a json is a "context" formatted field and it can either contain a single value in the case of unstruct_event, or an array in the case of derived_events and contexts.

   fieldList

   a list of configured PiiFields

   emitIdentificationEvent

   whether to emit an identification event

   strategy

   the pseudonymization strategy to use

8. final case class PiiScalar(fieldMutator: Mutator) extends PiiField with Product with Serializable

   

   Specifies a scalar field in POJO and the strategy that should be applied to it.

   Specifies a scalar field in POJO and the strategy that should be applied to it.

   fieldMutator

   the field mutator where the strategy will be applied

9. trait PiiStrategy extends AnyRef

   

   PiiStrategy trait.

   PiiStrategy trait. This corresponds to a strategy to apply to a single field. Currently only String input is supported.

10. final case class PiiStrategyPseudonymize(functionName: String, hashFunction: DigestFunction, salt: String) extends PiiStrategy with Product with Serializable

    

    Implements a pseudonymization strategy using any algorithm known to DigestFunction

    Implements a pseudonymization strategy using any algorithm known to DigestFunction

    functionName

    string representation of the function

    hashFunction

    the DigestFunction to apply

    salt

    salt added to the plain string before hashing