final case class ObjectSchemaField(name: String, active: Boolean = true, module: Option[String] = None, originalName: Option[String] = None, description: Option[String] = None, type: String = "object", indexProperties: IndexingProperties = IndexingProperties.empty, className: Option[String] = None, fields: Chunk[SchemaField] = Chunk.empty, modifiers: Chunk[FieldModifier] = Chunk.empty, required: Boolean = false, multiple: Boolean = false, order: Int = -1, isInternal: Boolean = false, customStringParser: Option[Script] = None, validators: Chunk[Validator] = Chunk.empty, inferrerInfos: Chunk[InferrerInfo] = Chunk.empty, isSensitive: Boolean = false, masking: Option[String] = None, checks: Chunk[Check] = Chunk.empty, creationDate: OffsetDateTime = OffsetDateTimeHelper.utcNow, creationUser: Id = User.SystemID, modificationDate: OffsetDateTime = OffsetDateTimeHelper.utcNow, modificationUser: Id = User.SystemID, metadata: Obj = Json.Obj()) extends SchemaField with Product with Serializable

This class defines a ObjectSchemaField entity

name

the name of the ObjectSchemaField entity

active

if this entity is active

module

the module associated to the ObjectSchemaField entity

type

the type of the ObjectSchemaField entity

indexProperties

a IndexingProperties entity

className

a string the rappresent the JVM ObjectSchemaField entity namespace

fields

a map of properties of this entity

required

if this field is required

multiple

if this field is multiple values

order

this defines the processing order

isInternal

if this field is internal use

customStringParser

a Option[Script] entity

validators

a list of Validator entities

inferrerInfos

a list of InferrerInfo entities

isSensitive

if the field is a PII

masking

the masking algorithm if defined

checks

an optinal validity check for the field

creationDate

the creation date of the ObjectSchemaField

creationUser

the reference of the user that created the ObjectSchemaField

modificationDate

the modification date of the ObjectSchemaField

modificationUser

the reference of last user that changed the ObjectSchemaField

Linear Supertypes
Serializable, Product, Equals, SchemaField, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjectSchemaField
  2. Serializable
  3. Product
  4. Equals
  5. SchemaField
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ObjectSchemaField(name: String, active: Boolean = true, module: Option[String] = None, originalName: Option[String] = None, description: Option[String] = None, type: String = "object", indexProperties: IndexingProperties = IndexingProperties.empty, className: Option[String] = None, fields: Chunk[SchemaField] = Chunk.empty, modifiers: Chunk[FieldModifier] = Chunk.empty, required: Boolean = false, multiple: Boolean = false, order: Int = -1, isInternal: Boolean = false, customStringParser: Option[Script] = None, validators: Chunk[Validator] = Chunk.empty, inferrerInfos: Chunk[InferrerInfo] = Chunk.empty, isSensitive: Boolean = false, masking: Option[String] = None, checks: Chunk[Check] = Chunk.empty, creationDate: OffsetDateTime = OffsetDateTimeHelper.utcNow, creationUser: Id = User.SystemID, modificationDate: OffsetDateTime = OffsetDateTimeHelper.utcNow, modificationUser: Id = User.SystemID, metadata: Obj = Json.Obj())

    name

    the name of the ObjectSchemaField entity

    active

    if this entity is active

    module

    the module associated to the ObjectSchemaField entity

    type

    the type of the ObjectSchemaField entity

    indexProperties

    a IndexingProperties entity

    className

    a string the rappresent the JVM ObjectSchemaField entity namespace

    fields

    a map of properties of this entity

    required

    if this field is required

    multiple

    if this field is multiple values

    order

    this defines the processing order

    isInternal

    if this field is internal use

    customStringParser

    a Option[Script] entity

    validators

    a list of Validator entities

    inferrerInfos

    a list of InferrerInfo entities

    isSensitive

    if the field is a PII

    masking

    the masking algorithm if defined

    checks

    an optinal validity check for the field

    creationDate

    the creation date of the ObjectSchemaField

    creationUser

    the reference of the user that created the ObjectSchemaField

    modificationDate

    the modification date of the ObjectSchemaField

    modificationUser

    the reference of last user that changed the ObjectSchemaField

Type Members

  1. type Self = ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val active: Boolean
    Definition Classes
    ObjectSchemaFieldSchemaField
  5. def addCheck(check: Check): Self
    Definition Classes
    SchemaField
  6. def addInferrerInfo(inferrerInfo: InferrerInfo): Self
    Definition Classes
    SchemaField
  7. def addModifier(modifier: FieldModifier): Self
    Definition Classes
    SchemaField
  8. def addValidator(validator: Validator): Self
    Definition Classes
    SchemaField
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val checks: Chunk[Check]
    Definition Classes
    ObjectSchemaFieldSchemaField
  11. val className: Option[String]
    Definition Classes
    ObjectSchemaFieldSchemaField
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  13. val creationDate: OffsetDateTime
    Definition Classes
    ObjectSchemaFieldSchemaField
  14. val creationUser: Id
    Definition Classes
    ObjectSchemaFieldSchemaField
  15. val customStringParser: Option[Script]
    Definition Classes
    ObjectSchemaFieldSchemaField
  16. def dataType: String
    Definition Classes
    ObjectSchemaFieldSchemaField
  17. val description: Option[String]
    Definition Classes
    ObjectSchemaFieldSchemaField
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val fields: Chunk[SchemaField]
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. def getField(name: String): Either[MissingFieldException, SchemaField]
    Definition Classes
    ObjectSchemaFieldSchemaField
  22. def getFlatFields: Chunk[SchemaField]

    Return a list of fields flattened

    Return a list of fields flattened

    Definition Classes
    ObjectSchemaFieldSchemaField
  23. def getMetadata[T](name: String, default: T)(implicit decoder: JsonDecoder[T]): Either[FrameworkException, T]
    Definition Classes
    SchemaField
  24. def getMetadata[T](name: String)(implicit decoder: JsonDecoder[T]): Either[FrameworkException, T]
    Definition Classes
    SchemaField
  25. val indexProperties: IndexingProperties
    Definition Classes
    ObjectSchemaFieldSchemaField
  26. val inferrerInfos: Chunk[InferrerInfo]
    Definition Classes
    ObjectSchemaFieldSchemaField
  27. def isEnum: Boolean
    Definition Classes
    ObjectSchemaFieldSchemaField
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. val isInternal: Boolean
    Definition Classes
    ObjectSchemaFieldSchemaField
  30. def isRoot: Boolean
  31. val isSensitive: Boolean
    Definition Classes
    ObjectSchemaFieldSchemaField
  32. val masking: Option[String]
    Definition Classes
    ObjectSchemaFieldSchemaField
  33. def merge(other: SchemaField, onlyExistsInFirst: Boolean): Either[MergeSchemaException, SchemaField]

    Merge Two schema in one.

    Merge Two schema in one.

    other

    the other schema to merge

    onlyExistsInFirst

    merge the field if only exists in the first one

    returns

    the merged schema

    Definition Classes
    SchemaField
  34. val metadata: Obj
    Definition Classes
    ObjectSchemaFieldSchemaField
  35. val modificationDate: OffsetDateTime
    Definition Classes
    ObjectSchemaFieldSchemaField
  36. val modificationUser: Id
    Definition Classes
    ObjectSchemaFieldSchemaField
  37. val modifiers: Chunk[FieldModifier]
    Definition Classes
    ObjectSchemaFieldSchemaField
  38. val module: Option[String]
  39. val multiple: Boolean
    Definition Classes
    ObjectSchemaFieldSchemaField
  40. val name: String
    Definition Classes
    ObjectSchemaFieldSchemaField
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  44. val order: Int
    Definition Classes
    ObjectSchemaFieldSchemaField
  45. val originalName: Option[String]
    Definition Classes
    ObjectSchemaFieldSchemaField
  46. def productElementNames: Iterator[String]
    Definition Classes
    Product
  47. val required: Boolean
    Definition Classes
    ObjectSchemaFieldSchemaField
  48. def setActive(active: Boolean): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  49. def setChecks(checks: Chunk[Check]): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  50. def setCreationDate(creationDate: OffsetDateTime): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  51. def setCreationUser(creationUser: Id): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  52. def setDescription(description: String): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  53. def setIndexProperties(indexProperties: IndexingProperties): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  54. def setInferrerInfos(inferrerInfos: Chunk[InferrerInfo]): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  55. def setIsSensitive(isSensitive: Boolean): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  56. def setMasking(masking: String): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  57. def setMetadata(metadata: Obj): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  58. def setMetadata[T](name: String, value: T)(implicit encoder: JsonEncoder[T]): Self
    Definition Classes
    SchemaField
  59. def setModificationDate(modificationDate: OffsetDateTime): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  60. def setModificationUser(modificationUser: Id): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  61. def setModifiers(modifiers: Chunk[FieldModifier]): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  62. def setMultiple(multiple: Boolean): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  63. def setName(name: String): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  64. def setOrder(order: Int): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  65. def setRequired(required: Boolean): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  66. def setValidators(validators: Chunk[Validator]): ObjectSchemaField
    Definition Classes
    ObjectSchemaFieldSchemaField
  67. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  68. val type: String
  69. val validators: Chunk[Validator]
    Definition Classes
    ObjectSchemaFieldSchemaField
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  72. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SchemaField

Inherited from AnyRef

Inherited from Any

Ungrouped