final case class BooleanSchemaField(name: String, active: Boolean = true, className: Option[String] = None, originalName: Option[String] = None, description: Option[String] = None, indexProperties: IndexingProperties = IndexingProperties.empty, default: Option[Boolean] = None, samples: Chunk[Boolean] = Chunk.empty, enum: Chunk[Boolean] = 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 TypedSchemaField[Boolean] with Product with Serializable

This class defines a BooleanSchemaField entity

name

the name of the BooleanSchemaField entity

active

if this entity is active

className

a string the rappresent the JVM BooleanSchemaField entity namespace

indexProperties

a IndexingProperties entity

default

a default value for the field

enum

a list of Boolean entities

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 BooleanSchemaField

creationUser

the reference of the user that created the BooleanSchemaField

modificationDate

the modification date of the BooleanSchemaField

modificationUser

the reference of last user that changed the BooleanSchemaField

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

Instance Constructors

  1. new BooleanSchemaField(name: String, active: Boolean = true, className: Option[String] = None, originalName: Option[String] = None, description: Option[String] = None, indexProperties: IndexingProperties = IndexingProperties.empty, default: Option[Boolean] = None, samples: Chunk[Boolean] = Chunk.empty, enum: Chunk[Boolean] = 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 BooleanSchemaField entity

    active

    if this entity is active

    className

    a string the rappresent the JVM BooleanSchemaField entity namespace

    indexProperties

    a IndexingProperties entity

    default

    a default value for the field

    enum

    a list of Boolean entities

    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 BooleanSchemaField

    creationUser

    the reference of the user that created the BooleanSchemaField

    modificationDate

    the modification date of the BooleanSchemaField

    modificationUser

    the reference of last user that changed the BooleanSchemaField

Type Members

  1. type Self = BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField

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
    BooleanSchemaFieldSchemaField
  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
    BooleanSchemaFieldSchemaField
  11. val className: Option[String]
    Definition Classes
    BooleanSchemaFieldSchemaField
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  13. val creationDate: OffsetDateTime
    Definition Classes
    BooleanSchemaFieldSchemaField
  14. val creationUser: Id
    Definition Classes
    BooleanSchemaFieldSchemaField
  15. val customStringParser: Option[Script]
    Definition Classes
    BooleanSchemaFieldSchemaField
  16. def dataType: String
    Definition Classes
    BooleanSchemaFieldSchemaField
  17. val default: Option[Boolean]

    a optinal default value

    a optinal default value

    Definition Classes
    BooleanSchemaFieldTypedSchemaField
  18. val description: Option[String]
    Definition Classes
    BooleanSchemaFieldSchemaField
  19. val enum: Chunk[Boolean]
    Definition Classes
    BooleanSchemaFieldTypedSchemaField
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  22. def getField(name: String): Either[MissingFieldException, SchemaField]
    Definition Classes
    TypedSchemaFieldSchemaField
  23. def getFlatFields: Chunk[SchemaField]

    Return a list of fields flattened

    Return a list of fields flattened

    Definition Classes
    BooleanSchemaFieldSchemaField
  24. def getMetadata[T](name: String, default: T)(implicit decoder: JsonDecoder[T]): Either[FrameworkException, T]
    Definition Classes
    SchemaField
  25. def getMetadata[T](name: String)(implicit decoder: JsonDecoder[T]): Either[FrameworkException, T]
    Definition Classes
    SchemaField
  26. val indexProperties: IndexingProperties
    Definition Classes
    BooleanSchemaFieldSchemaField
  27. val inferrerInfos: Chunk[InferrerInfo]
    Definition Classes
    BooleanSchemaFieldSchemaField
  28. def isEnum: Boolean
    Definition Classes
    TypedSchemaFieldSchemaField
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. val isInternal: Boolean
    Definition Classes
    BooleanSchemaFieldSchemaField
  31. val isSensitive: Boolean
    Definition Classes
    BooleanSchemaFieldSchemaField
  32. val masking: Option[String]
    Definition Classes
    BooleanSchemaFieldSchemaField
  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. def meta: SchemaFieldType[Boolean]
    Definition Classes
    BooleanSchemaFieldTypedSchemaField
  35. val metadata: Obj
    Definition Classes
    BooleanSchemaFieldSchemaField
  36. val modificationDate: OffsetDateTime
    Definition Classes
    BooleanSchemaFieldSchemaField
  37. val modificationUser: Id
    Definition Classes
    BooleanSchemaFieldSchemaField
  38. val modifiers: Chunk[FieldModifier]
    Definition Classes
    BooleanSchemaFieldSchemaField
  39. val multiple: Boolean
    Definition Classes
    BooleanSchemaFieldSchemaField
  40. val name: String
    Definition Classes
    BooleanSchemaFieldSchemaField
  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
    BooleanSchemaFieldSchemaField
  45. val originalName: Option[String]
    Definition Classes
    BooleanSchemaFieldSchemaField
  46. def productElementNames: Iterator[String]
    Definition Classes
    Product
  47. val required: Boolean
    Definition Classes
    BooleanSchemaFieldSchemaField
  48. val samples: Chunk[Boolean]

    a list of value test_samples

    a list of value test_samples

    Definition Classes
    BooleanSchemaFieldTypedSchemaField
  49. def setActive(active: Boolean): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  50. def setChecks(checks: Chunk[Check]): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  51. def setCreationDate(creationDate: OffsetDateTime): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  52. def setCreationUser(creationUser: Id): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  53. def setDescription(description: String): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  54. def setIndexProperties(indexProperties: IndexingProperties): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  55. def setInferrerInfos(inferrerInfos: Chunk[InferrerInfo]): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  56. def setIsSensitive(isSensitive: Boolean): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  57. def setMasking(masking: String): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  58. def setMetadata(metadata: Obj): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  59. def setMetadata[T](name: String, value: T)(implicit encoder: JsonEncoder[T]): Self
    Definition Classes
    SchemaField
  60. def setModificationDate(modificationDate: OffsetDateTime): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  61. def setModificationUser(modificationUser: Id): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  62. def setModifiers(modifiers: Chunk[FieldModifier]): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  63. def setMultiple(multiple: Boolean): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  64. def setName(name: String): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  65. def setOrder(order: Int): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  66. def setRequired(required: Boolean): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  67. def setValidators(validators: Chunk[Validator]): BooleanSchemaField
    Definition Classes
    BooleanSchemaFieldSchemaField
  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. val validators: Chunk[Validator]
    Definition Classes
    BooleanSchemaFieldSchemaField
  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 TypedSchemaField[Boolean]

Inherited from SchemaField

Inherited from AnyRef

Inherited from Any

Ungrouped