t

com.johnsnowlabs.nlp.annotators.deid

AuxEncryptionParams

trait AuxEncryptionParams extends Params

Adds the aux (mappings) column encryption key to an annotator.

The de-identification annotators use it to encrypt the mappings column they produce, and ReIdentification uses it to decrypt that column back. The same key must be set on both sides.

When the key is left empty (the default) nothing is encrypted and the mappings column keeps the plain behavior it has always had.

The key is never stored in clear text: setAuxEncryptionKey wraps it with a key embedded in the jar before putting it into the param, so a saved pipeline only contains the wrapped form. The wrapping is transparent to the user, who always sets and thinks in terms of their own key.

Linear Supertypes
Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
DeIdentification, DeIdentificationModel, LightDeIdentification, MappingsColumnModel, MappingsColumnParams, ReIdentification, Replacer
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AuxEncryptionParams
  2. Params
  3. Serializable
  4. Serializable
  5. Identifiable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val auxEncryptionKey: Param[String]

    The key used to encrypt and decrypt the mappings (aux) column.

    The key used to encrypt and decrypt the mappings (aux) column. Empty means no encryption.

  7. final def clear(param: Param[_]): AuxEncryptionParams.this.type
    Definition Classes
    Params
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  10. def decryptMappingAnnotation(annotation: Annotation, key: String): Annotation

    Decrypts a mappings chunk annotation produced with encryptMappingAnnotation.

    Decrypts a mappings chunk annotation produced with encryptMappingAnnotation.

    Attributes
    protected
  11. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  12. def encryptMappingAnnotation(annotation: Annotation, key: String): Annotation

    Encrypts the sensitive fields of a mappings chunk annotation.

    Encrypts the sensitive fields of a mappings chunk annotation.

    Attributes
    protected
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  16. def explainParams(): String
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  21. def getAuxEncryptionKey: String

    Gets auxEncryptionKey as stored, that is in its wrapped form.

  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  24. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  25. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  26. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  27. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def isAuxEncryptionEnabled: Boolean

    Whether a key was provided, which is what turns aux encryption on.

    Whether a key was provided, which is what turns aux encryption on.

    Attributes
    protected
  30. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  37. def resolvedAuxKey: String

    The usable key, unwrapped from its stored form.

    The usable key, unwrapped from its stored form. Empty when encryption is disabled.

    Attributes
    protected
  38. final def set(paramPair: ParamPair[_]): AuxEncryptionParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  39. final def set(param: String, value: Any): AuxEncryptionParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  40. final def set[T](param: Param[T], value: T): AuxEncryptionParams.this.type
    Definition Classes
    Params
  41. def setAuxEncryptionKey(value: String): AuxEncryptionParams.this.type

    Sets the key used to encrypt and decrypt the mappings (aux) column.

    Sets the key used to encrypt and decrypt the mappings (aux) column.

    When set on a de-identification annotator, the original values carried by the mappings column are encrypted with AES-256-GCM. ReIdentification needs the very same key to restore the original text. When left unset, the mappings column is produced in clear text as before.

  42. final def setDefault(paramPairs: ParamPair[_]*): AuxEncryptionParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  43. final def setDefault[T](param: Param[T], value: T): AuxEncryptionParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  44. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameter getters

Parameters

Parameter setters

Ungrouped