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
- Alphabetic
- By Inheritance
- ObjectSchemaField
- Serializable
- Product
- Equals
- SchemaField
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- type Self = ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val active: Boolean
- Definition Classes
- ObjectSchemaField → SchemaField
- def addCheck(check: Check): Self
- Definition Classes
- SchemaField
- def addInferrerInfo(inferrerInfo: InferrerInfo): Self
- Definition Classes
- SchemaField
- def addModifier(modifier: FieldModifier): Self
- Definition Classes
- SchemaField
- def addValidator(validator: Validator): Self
- Definition Classes
- SchemaField
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val checks: Chunk[Check]
- Definition Classes
- ObjectSchemaField → SchemaField
- val className: Option[String]
- Definition Classes
- ObjectSchemaField → SchemaField
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val creationDate: OffsetDateTime
- Definition Classes
- ObjectSchemaField → SchemaField
- val creationUser: Id
- Definition Classes
- ObjectSchemaField → SchemaField
- val customStringParser: Option[Script]
- Definition Classes
- ObjectSchemaField → SchemaField
- def dataType: String
- Definition Classes
- ObjectSchemaField → SchemaField
- val description: Option[String]
- Definition Classes
- ObjectSchemaField → SchemaField
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fields: Chunk[SchemaField]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getField(name: String): Either[MissingFieldException, SchemaField]
- Definition Classes
- ObjectSchemaField → SchemaField
- def getFlatFields: Chunk[SchemaField]
Return a list of fields flattened
Return a list of fields flattened
- Definition Classes
- ObjectSchemaField → SchemaField
- def getMetadata[T](name: String, default: T)(implicit decoder: JsonDecoder[T]): Either[FrameworkException, T]
- Definition Classes
- SchemaField
- def getMetadata[T](name: String)(implicit decoder: JsonDecoder[T]): Either[FrameworkException, T]
- Definition Classes
- SchemaField
- val indexProperties: IndexingProperties
- Definition Classes
- ObjectSchemaField → SchemaField
- val inferrerInfos: Chunk[InferrerInfo]
- Definition Classes
- ObjectSchemaField → SchemaField
- def isEnum: Boolean
- Definition Classes
- ObjectSchemaField → SchemaField
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isInternal: Boolean
- Definition Classes
- ObjectSchemaField → SchemaField
- def isRoot: Boolean
- val isSensitive: Boolean
- Definition Classes
- ObjectSchemaField → SchemaField
- val masking: Option[String]
- Definition Classes
- ObjectSchemaField → SchemaField
- 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
- val metadata: Obj
- Definition Classes
- ObjectSchemaField → SchemaField
- val modificationDate: OffsetDateTime
- Definition Classes
- ObjectSchemaField → SchemaField
- val modificationUser: Id
- Definition Classes
- ObjectSchemaField → SchemaField
- val modifiers: Chunk[FieldModifier]
- Definition Classes
- ObjectSchemaField → SchemaField
- val module: Option[String]
- val multiple: Boolean
- Definition Classes
- ObjectSchemaField → SchemaField
- val name: String
- Definition Classes
- ObjectSchemaField → SchemaField
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val order: Int
- Definition Classes
- ObjectSchemaField → SchemaField
- val originalName: Option[String]
- Definition Classes
- ObjectSchemaField → SchemaField
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val required: Boolean
- Definition Classes
- ObjectSchemaField → SchemaField
- def setActive(active: Boolean): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setChecks(checks: Chunk[Check]): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setCreationDate(creationDate: OffsetDateTime): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setCreationUser(creationUser: Id): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setDescription(description: String): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setIndexProperties(indexProperties: IndexingProperties): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setInferrerInfos(inferrerInfos: Chunk[InferrerInfo]): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setIsSensitive(isSensitive: Boolean): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setMasking(masking: String): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setMetadata(metadata: Obj): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setMetadata[T](name: String, value: T)(implicit encoder: JsonEncoder[T]): Self
- Definition Classes
- SchemaField
- def setModificationDate(modificationDate: OffsetDateTime): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setModificationUser(modificationUser: Id): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setModifiers(modifiers: Chunk[FieldModifier]): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setMultiple(multiple: Boolean): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setName(name: String): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setOrder(order: Int): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setRequired(required: Boolean): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- def setValidators(validators: Chunk[Validator]): ObjectSchemaField
- Definition Classes
- ObjectSchemaField → SchemaField
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val type: String
- val validators: Chunk[Validator]
- Definition Classes
- ObjectSchemaField → SchemaField
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)