Class/Object

com.jcdecaux.setl

Setl

Related Docs: object Setl | package setl

Permalink

abstract class Setl extends HasRegistry[Pipeline]

Annotations
@Evolving()
Linear Supertypes
HasRegistry[Pipeline], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Setl
  2. HasRegistry
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Setl(configLoader: ConfigLoader)

    Permalink

Abstract Value Members

  1. abstract val spark: SparkSession

    Permalink

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clearRegistry(): Unit

    Permalink

    Clear the registry

    Clear the registry

    Attributes
    protected
    Definition Classes
    HasRegistry
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val configLoader: ConfigLoader

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def getConnector[CN <: Connector](connectorId: String): CN

    Permalink

    Get a Connector.

    Get a Connector. If the given config path hasn't been registered, then the connector will firstly be registered and then be returned.

    CN

    type of the connector

    connectorId

    id of connector (could be the config path)

    returns

    the registered connector

  13. def getPipeline(uuid: UUID): Option[Pipeline]

    Permalink

    Find a pipeline by its UUID

    Find a pipeline by its UUID

    uuid

    UUID of the target pipeline

  14. def getRegisteredItem(uuid: UUID): Option[Pipeline]

    Permalink

    For a given UUID, return the corresponding registered item

    For a given UUID, return the corresponding registered item

    uuid

    uuid

    Definition Classes
    HasRegistry
  15. def getRegistry: ListMap[UUID, Pipeline]

    Permalink

    Return the registry

    Return the registry

    Definition Classes
    HasRegistry
  16. def getRegistryLength: Long

    Permalink

    Return the number of items in the current registry

    Return the number of items in the current registry

    Definition Classes
    HasRegistry
  17. def getSparkRepository[DT](repositoryId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[DT]): SparkRepository[DT]

    Permalink

    Get a SparkRepository[DT].

    Get a SparkRepository[DT]. If the given config path hasn't been registered, then the repository will firstly be registered and then be returned.

    DT

    type of spark repository

    repositoryId

    path to spark repository configuration

    returns

    the added repository

  18. def hasRegisteredItem(uuid: UUID): Boolean

    Permalink

    Check if the UUID exists in the registry

    Check if the UUID exists in the registry

    uuid

    an UUID

    returns

    true if it already exists in the registry, false otherwise

    Definition Classes
    HasRegistry
  19. def hasRegisteredItem(item: Identifiable): Boolean

    Permalink

    Check if the Identifiable exists in the registry

    Check if the Identifiable exists in the registry

    item

    an object that inherit com.jcdecaux.setl.internal.Identifiable

    returns

    true if it already exists in the registry, false otherwise

    Definition Classes
    HasRegistry
  20. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  22. def isRegistryEmpty: Boolean

    Permalink

    Return true if the registry is empty, false otherwise

    Return true if the registry is empty, false otherwise

    Definition Classes
    HasRegistry
  23. def lastRegisteredItem: Option[Pipeline]

    Permalink

    Return the last registered item

    Return the last registered item

    returns

    if the registry is empty, None will be returned

    Definition Classes
    HasRegistry
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. def newPipeline(): Pipeline

    Permalink

    Create a new pipeline.

    Create a new pipeline. All the registered repositories and connectors will be passed into the delivery pool of the pipeline.

    returns

    a newly instantiated pipeline object

  26. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  28. def registerNewItem(item: Pipeline): Unit

    Permalink

    Register a new com.jcdecaux.setl.internal.Identifiable in registry

    Register a new com.jcdecaux.setl.internal.Identifiable in registry

    item

    an object that inherit com.jcdecaux.setl.internal.Identifiable

    returns

    true if the given item is registered, false otherwise

    Attributes
    protected
    Definition Classes
    HasRegistry
    Annotations
    @throws( ... )
  29. def registerNewItems(items: Iterable[Pipeline]): Unit

    Permalink

    Register multiple items

    Register multiple items

    items

    an com.jcdecaux.setl.internal.Identifiable object

    Attributes
    protected
    Definition Classes
    HasRegistry
  30. def resetConnector[CN <: Connector](connector: CN, deliveryId: String, connectorId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[CN]): Setl.this.type

    Permalink

    Register a connector.

    Register a connector.

    If there this config path has been registered, it will be updated.

    CN

    type of spark connector

    connector

    a connector

    deliveryId

    delivery ID

    returns

    the current SETL context with the added repository

  31. def resetConnector[CN <: Connector](configPath: String, deliveryId: String, cls: Class[CN])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[CN]): Setl.this.type

    Permalink

    Register a connector.

    Register a connector.

    If there this config path has been registered, it will be updated.

    CN

    type of spark connector

    configPath

    path to connector configuration

    deliveryId

    delivery ID

    cls

    class of the Connector

    returns

    the current SETL context with the added repository

  32. def resetSparkRepository[DT](config: String, consumer: Seq[Class[_ <: Factory[_]]] = Seq.empty, deliveryId: String = Deliverable.DEFAULT_ID, readCache: Boolean = false)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[DT]): Setl.this.type

    Permalink

    Force register a spark repository for the given config path.

    Force register a spark repository for the given config path. If there this config path has been registered, it will be updated

    DT

    type of spark repository

    config

    path to spark repository configuration

    consumer

    Seq of consumer

    deliveryId

    id of this delivery that will be used during the delivery matching

    returns

    the current SETL context with the added repository

  33. def resetSparkRepository[DT](repository: SparkRepository[DT], consumer: Seq[Class[_ <: Factory[_]]], deliveryId: String, repositoryId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[DT]): Setl.this.type

    Permalink

    Force register a spark repository with an object of SparkRepository and its id.

    Force register a spark repository with an object of SparkRepository and its id. If a repository having the same ID was already registered, it will be overwritten by this one.

    DT

    data type of the repository

    repository

    an object of SparkRepository[T]

    consumer

    consumer of this spark repository

    deliveryId

    id of this delivery

    repositoryId

    id to be used for the repository registration

    returns

    the current SETL context with the added repository

  34. def setConnector[CN <: Connector](connector: CN, deliveryId: String, connectorId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[CN]): Setl.this.type

    Permalink

    Register a connector.

    Register a connector.

    If there this config path has been registered, it will NOT be updated.

    CN

    type of spark connector

    connector

    a connector

    deliveryId

    delivery ID

    connectorId

    id of the Connector

    returns

    the current SETL context with the added repository

  35. def setConnector[CN <: Connector](config: String, deliveryId: String, cls: Class[CN])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[CN]): Setl.this.type

    Permalink

    Register a connector.

    Register a connector.

    If there this config path has been registered, it will NOT be updated.

    CN

    type of spark connector

    config

    path to connector configuration

    deliveryId

    delivery ID

    cls

    class of the Connector

    returns

    the current SETL context with the added repository

  36. def setConnector[CN <: Connector](config: String, cls: Class[CN])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[CN]): Setl.this.type

    Permalink

    Register a connector.

    Register a connector. As each connector must have an delivery ID, by default the config path will be used.

    If there this config path has been registered, it will NOT be updated.

    CN

    type of connector

    config

    path to connector configuration

    returns

    the current SETL context with the added repository

  37. def setConnector(config: String, deliveryId: String): Setl.this.type

    Permalink

    Register a connector.

    Register a connector.

    If there this config path has been registered, it will NOT be updated.

    config

    path to connector configuration

    deliveryId

    delivery ID

    returns

    the current SETL context with the added connector

  38. def setConnector(config: String): Setl.this.type

    Permalink

    Register a connector.

    Register a connector. As each connector must have an delivery ID, by default the config path will be used.

    If there this config path has been registered, it will NOT be updated.

    config

    path to connector configuration

  39. def setSparkRepository[DT](repository: SparkRepository[DT], consumer: Seq[Class[_ <: Factory[_]]], deliveryId: String, repositoryId: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[DT]): Setl.this.type

    Permalink

    Register a spark repository with an object of SparkRepository and its id.

    Register a spark repository with an object of SparkRepository and its id. If a repository having the same ID was already registered, it will NOT be overwritten by this one.

    DT

    data type of the repository

    repository

    an object of SparkRepository[T]

    consumer

    consumer of this spark repository

    deliveryId

    id of this delivery

    repositoryId

    id to be used for the repository registration

    returns

    the current SETL context with the added repository

  40. def setSparkRepository[DT](config: String, consumer: Seq[Class[_ <: Factory[_]]] = Seq.empty, deliveryId: String = Deliverable.DEFAULT_ID, readCache: Boolean = false)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[DT]): Setl.this.type

    Permalink

    Register a spark repository for the given config path.

    Register a spark repository for the given config path. If there this config path has been registered, it will NOT be updated

    DT

    type of spark repository

    config

    path to spark repository configuration

    consumer

    Seq of consumer

    deliveryId

    id of this delivery that will be used during the delivery matching

    returns

    the current SETL context with the added repository

  41. def sparkSession: SparkSession

    Permalink

    Return the current spark session

  42. def stop(): Unit

    Permalink

    Stop the spark session

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

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

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

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

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

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

Inherited from HasRegistry[Pipeline]

Inherited from AnyRef

Inherited from Any

Ungrouped