Metadata

Specify Schema properties. These properties may be specified at the schema or domain level Any property non specified at the schema level is taken from the one specified at the domain level or else the default value is returned.

mode: : FILE mode by default
format: : DSV by default
encoding: : UTF-8 by default
multiline: : are json objects on a single line or multiple line ? Single by default. false means single. false also means faster
array: : Is a json stored as a single object array ? false by default
withHeader: : does the dataset has a header ? true bu default
separator: : the column separator, ';' by default
quote: : The String quote char, '"' by default
escape: : escaping char '\' by default
write: : Write mode, APPEND by default
partition: : Partition columns, no partitioning by default
index: : should the dataset be indexed in elasticsearch after ingestion ?

Annotations: @JsonDeserialize()

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Metadata(mode: Option[Mode] = None, format: Option[Format] = None, encoding: Option[String] = None, multiline: Option[Boolean] = None, array: Option[Boolean] = None, withHeader: Option[Boolean] = None, separator: Option[String] = None, quote: Option[String] = None, escape: Option[String] = None, write: Option[WriteMode] = None, partition: Option[Partition] = None, index: Option[IndexSink] = None, properties: Option[Map[String, String]] = None)

mode
: FILE mode by default
format
: DSV by default
encoding
: UTF-8 by default
multiline
: are json objects on a single line or multiple line ? Single by default. false means single. false also means faster
array
: Is a json stored as a single object array ? false by default
withHeader
: does the dataset has a header ? true bu default
separator
: the column separator, ';' by default
quote
: The String quote char, '"' by default
escape
: escaping char '\' by default
write
: Write mode, APPEND by default
partition
: Partition columns, no partitioning by default
index
: should the dataset be indexed in elasticsearch after ingestion ?

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 array: Option[Boolean]

: Is a json stored as a single object array ? false by default
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val encoding: Option[String]

: UTF-8 by default
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val escape: Option[String]

: escaping char '\' by default
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val format: Option[Format]

: DSV by default
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getEncoding(): String
def getEscape(): String
def getFormat(): Format
def getIndexSink(): Option[IndexSink]
def getIngestMode(): Mode
def getMultiline(): Boolean
def getPartitionAttributes(): List[String]
def getProperties(): Map[String, String]
def getQuote(): String
def getSamplingStrategy(): Double
def getSeparator(): String
def getWriteMode(): WriteMode
def import(child: Metadata): Metadata

Merge this metadata with its child.
Merge this metadata with its child. Any property defined at the child level overrides the one defined at this level This allow a schema to override the domain metadata attribute Applied to a Domain level metadata
child
: Schema level metadata
returns
the metadata resulting of the merge of the schema and the domain metadata.
val index: Option[IndexSink]

: should the dataset be indexed in elasticsearch after ingestion ?
def isArray(): Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isWithHeader(): Boolean
def merge[T](parent: Option[T], child: Option[T]): Option[T]

Merge a single attribute
Merge a single attribute
parent
: Domain level metadata attribute
child
: Schema level metadata attribute
returns
attribute if merge, the domain attribute otherwise.

Attributes
protected
val mode: Option[Mode]

: FILE mode by default
val multiline: Option[Boolean]

: are json objects on a single line or multiple line ? Single by default.
: are json objects on a single line or multiple line ? Single by default. false means single. false also means faster
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val partition: Option[Partition]

: Partition columns, no partitioning by default
val properties: Option[Map[String, String]]
val quote: Option[String]

: The String quote char, '"' by default
val separator: Option[String]

: the column separator, ';' by default
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Metadata → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val withHeader: Option[Boolean]

: does the dataset has a header ? true bu default
val write: Option[WriteMode]

: Write mode, APPEND by default

Related Docs: object Metadata | package model

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val array: Option[Boolean]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val encoding: Option[String]

final def eq(arg0: AnyRef): Boolean

val escape: Option[String]

def finalize(): Unit

val format: Option[Format]

final def getClass(): Class[_]

def getEncoding(): String

def getEscape(): String

def getFormat(): Format

def getIndexSink(): Option[IndexSink]

def getIngestMode(): Mode

def getMultiline(): Boolean

def getPartitionAttributes(): List[String]

def getProperties(): Map[String, String]

def getQuote(): String

def getSamplingStrategy(): Double

def getSeparator(): String

def getWriteMode(): WriteMode

def import(child: Metadata): Metadata

val index: Option[IndexSink]

def isArray(): Boolean

final def isInstanceOf[T0]: Boolean

def isWithHeader(): Boolean

def merge[T](parent: Option[T], child: Option[T]): Option[T]

val mode: Option[Mode]

val multiline: Option[Boolean]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val partition: Option[Partition]

val properties: Option[Map[String, String]]

val quote: Option[String]

val separator: Option[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val withHeader: Option[Boolean]

val write: Option[WriteMode]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped