Object

ai.tripl.arc.api

API

Related Doc: package api

Permalink

object API

The API defines the model for a pipline. It is made up of stages, extract, transform and load with their respective settings.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. API
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class ARCContext(jobId: Option[String], jobName: Option[String], environment: Option[String], environmentId: Option[String], configUri: Option[String], isStreaming: Boolean, ignoreEnvironments: Boolean, storageLevel: StorageLevel, immutableViews: Boolean, commandLineArguments: Map[String, String], dynamicConfigurationPlugins: List[DynamicConfigurationPlugin], lifecyclePlugins: List[LifecyclePlugin], activeLifecyclePlugins: List[LifecyclePluginInstance], pipelineStagePlugins: List[PipelineStagePlugin], udfPlugins: List[UDFPlugin], userData: Map[String, AnyRef]) extends Product with Serializable

    Permalink

    ARCContext is used to define immutable global run parameters.

  2. sealed trait AmazonS3EncryptionType extends AnyRef

    Permalink
  3. sealed trait Authentication extends AnyRef

    Permalink
  4. case class BinaryColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], encoding: EncodingType, metadata: Option[String]) extends ExtractColumn with Product with Serializable

    Permalink
  5. case class BooleanColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], trueValues: List[String], falseValues: List[String], metadata: Option[String]) extends ExtractColumn with Product with Serializable

    Permalink

    true / false values are lists of strings that are considered equivalent to true or false e.g.

    true / false values are lists of strings that are considered equivalent to true or false e.g. "Y", "yes", "N", "no".

  6. trait ConfigPlugin[T] extends VersionedPlugin

    Permalink
  7. case class CsvReaderOptions(hasHeader: Boolean, ignoreHeader: Boolean, delimiter: Char) extends ExtractReaderOptions with Product with Serializable

    Permalink
  8. case class DateColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], formatters: List[String], metadata: Option[String], strict: Boolean) extends ExtractColumn with Product with Serializable

    Permalink

    Formatters is a list of valid Java Time formats.

    Formatters is a list of valid Java Time formats. Will attemp to parse in order so most likely match should be first.

  9. case class DecimalColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], precision: Int, scale: Int, metadata: Option[String], formatters: Option[List[String]]) extends ExtractColumn with Product with Serializable

    Permalink
  10. case class DoubleColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], metadata: Option[String], formatters: Option[List[String]]) extends ExtractColumn with Product with Serializable

    Permalink
  11. case class ETLPipeline(stages: List[PipelineStage]) extends Product with Serializable

    Permalink
  12. sealed trait EncodingType extends AnyRef

    Permalink
  13. case class ErrorRow(row: String, rowIndex: Long, err: String) extends Product with Serializable

    Permalink
  14. sealed trait ExtractColumn extends AnyRef

    Permalink

    ExtractColumns are used to define schemas for typing transforms as well as when extracting from sources that lack a schema such as CSV.

  15. sealed trait ExtractReaderOptions extends AnyRef

    Permalink
  16. sealed trait FailModeType extends AnyRef

    Permalink
  17. case class IntegerColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean = true, nullableValues: List[String], metadata: Option[String], formatters: Option[List[String]]) extends ExtractColumn with Product with Serializable

    Permalink
  18. sealed trait IsolationLevelType extends AnyRef

    Permalink
  19. trait LifecyclePluginInstance extends AnyRef

    Permalink
  20. case class LongColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], metadata: Option[String], formatters: Option[List[String]]) extends ExtractColumn with Product with Serializable

    Permalink
  21. sealed trait MetadataFormat extends AnyRef

    Permalink
  22. case class MetadataSchema(name: String, format: MetadataFormat) extends Product with Serializable

    Permalink
  23. sealed trait OutputModeType extends AnyRef

    Permalink
  24. trait PipelineStage extends AnyRef

    Permalink
  25. sealed trait ResponseType extends AnyRef

    Permalink
  26. case class StringColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], metadata: Option[String], minLength: Option[Int], maxLength: Option[Int]) extends ExtractColumn with Product with Serializable

    Permalink
  27. case class TimeColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], formatters: List[String], metadata: Option[String]) extends ExtractColumn with Product with Serializable

    Permalink

    Formatters is a list of valid Java Time formats.

    Formatters is a list of valid Java Time formats. Will attemp to parse in order so most likely match should be first.

  28. case class TimestampColumn(id: String, name: String, description: Option[String], nullable: Boolean, nullReplacementValue: Option[String], trim: Boolean, nullableValues: List[String], timezoneId: String, formatters: List[String], time: Option[LocalTime], metadata: Option[String], strict: Boolean) extends ExtractColumn with Product with Serializable

    Permalink

    Formatters is a list of valid Java Time formats.

    Formatters is a list of valid Java Time formats. Will attemp to parse in order so most likely match should be first.

  29. case class TypingError(field: String, message: String) extends Product with Serializable

    Permalink
  30. trait VersionedPlugin extends Serializable

    Permalink
  31. case class Watermark(eventTime: String, delayThreshold: String) extends Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object AmazonS3EncryptionType

    Permalink
  5. object Authentication

    Permalink
  6. object DoubleResponse extends ResponseType with Product with Serializable

    Permalink
  7. object EncodingTypeBase64 extends EncodingType with Product with Serializable

    Permalink
  8. object EncodingTypeHexadecimal extends EncodingType with Product with Serializable

    Permalink
  9. object Extract

    Permalink
  10. object ExtractColumn

    Permalink
  11. object FailModeTypeFailFast extends FailModeType with Product with Serializable

    Permalink
  12. object FailModeTypePermissive extends FailModeType with Product with Serializable

    Permalink
  13. object IntegerResponse extends ResponseType with Product with Serializable

    Permalink
  14. object IsolationLevelNone extends IsolationLevelType with Product with Serializable

    Permalink
  15. object IsolationLevelReadCommitted extends IsolationLevelType with Product with Serializable

    Permalink
  16. object IsolationLevelReadUncommitted extends IsolationLevelType with Product with Serializable

    Permalink
  17. object IsolationLevelRepeatableRead extends IsolationLevelType with Product with Serializable

    Permalink
  18. object IsolationLevelSerializable extends IsolationLevelType with Product with Serializable

    Permalink
  19. object MetadataFormat

    Permalink
  20. object OutputModeTypeAppend extends OutputModeType with Product with Serializable

    Permalink
  21. object OutputModeTypeComplete extends OutputModeType with Product with Serializable

    Permalink
  22. object OutputModeTypeUpdate extends OutputModeType with Product with Serializable

    Permalink
  23. object StringResponse extends ResponseType with Product with Serializable

    Permalink
  24. object TypingError extends Serializable

    Permalink
  25. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  26. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped