Object/Trait

com.snowplowanalytics.iglu.schemaddl.migrations

SchemaList

Related Docs: trait SchemaList | package migrations

Permalink

object SchemaList extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaList
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait FullListCreationError extends Product with Serializable

    Permalink

    Represents errors while creating SchemaFullList

  2. sealed trait ModelGroupList extends AnyRef

    Permalink

    Always belong to the same vendor/name/model triple, however different from SchemaList, no ordering is implied.

  3. case class SchemaListFull extends SchemaList with Product with Serializable

    Permalink

    Always belong to the same vendor/name/model triple, always have at least two elements: head (initial x-0-0 schema) and latest schema

  4. final case class SchemaListSegment extends AnyVal with Product with Serializable

    Permalink

    Has all properties of SchemaListFull except that it can miss initial or last schemas

  5. case class SingleSchema extends SchemaList with Product with Serializable

    Permalink

    Represents schema list with single item.

    Represents schema list with single item. It's version is always first of the model group such that 1-0-0, 2-0-0 etc.

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 FullListCreationError extends Serializable

    Permalink

  5. object ModelGroupList

    Permalink

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def buildMultiple(schemas: NonEmptyList[IgluSchema]): Ior[NonEmptyList[FullListCreationError], NonEmptyList[SchemaList]]

    Permalink

    Construct SchemaLists from unordered list

    Construct SchemaLists from unordered list

    schemas

    non-empty list of schemas which can belong to different model groups

    returns

    non-empty list of errors while creating SchemaLists in Ior.left and non-empty list of SchemaList which created from given schemas in Ior.right

  8. def buildMultipleFromFetchedSchemas[F[_], E](fetch: ⇒ EitherT[F, E, NonEmptyList[IgluSchema]])(implicit arg0: Monad[F]): EitherT[F, E, NonEmptyList[SchemaList]]

    Permalink

    Fetch NonEmptyList of IgluSchemas from Iglu Server, using generic resolution function

    Fetch NonEmptyList of IgluSchemas from Iglu Server, using generic resolution function

    fetch

    resolution function

    returns

    list of SchemaLists which created from fetched schemas

  9. def buildSingleSchema(schema: IgluSchema): Option[SchemaList]

    Permalink

    Construct SingleSchema from given Schema if it is first version of its model group

    Construct SingleSchema from given Schema if it is first version of its model group

    schema

    IgluSchems to create SingleSchema

    returns

    None if given schema is not first version of its model group Some(SingleSchema(schema)) otherwise

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. def fromSchemaList[F[_], E](keys: core.SchemaList, fetch: (SchemaKey) ⇒ EitherT[F, E, IgluSchema])(implicit arg0: Monad[F]): EitherT[F, E, SchemaList]

    Permalink

    Fetch from Iglu Server and parse each schema from SchemaKeyList, using generic resolution function (IO-dependent) valid constructor of SchemaList

    Fetch from Iglu Server and parse each schema from SchemaKeyList, using generic resolution function (IO-dependent) valid constructor of SchemaList

    keys

    non-empty properly ordered list of SchemaKeys, fetched from Iglu Server

    fetch

    resolution function

    returns

    properly ordered list of parsed JSON Schemas

  15. def fromUnambiguous(modelGroup: ModelGroupList): Either[FullListCreationError, SchemaList]

    Permalink

    Construct SchemaList from list of schemas, but only if order is unambiguous (and no gaps) (static) valid constructor of SchemaList If order is ambiguous (left returned) then the only safe order can be retrieved from Iglu Server (by fromSchemaList), use other constructors on your own risk

    Construct SchemaList from list of schemas, but only if order is unambiguous (and no gaps) (static) valid constructor of SchemaList If order is ambiguous (left returned) then the only safe order can be retrieved from Iglu Server (by fromSchemaList), use other constructors on your own risk

    modelGroup

    non-empty list of schema belonging to the same ModelGroup

    returns

    error object as Either.left in case of transformation is not successful or created SchemaList as Either.right if everything is okay

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. def unsafeBuildWithReorder(modelGroup: ModelGroupList): Either[FullListCreationError, SchemaList]

    Permalink

    Construct SchemaList from list of schemas, if there is no gaps.

    Construct SchemaList from list of schemas, if there is no gaps. Order given model group according to their schema key and resulting ordering might not be correct if given schema list ambiguous therefore it is not safe to use this function with ambiguous schema list.

    modelGroup

    non-empty list of schema belonging to the same ModelGroup

    returns

    error object as Either.left in case of transformation is not successful or created SchemaList as Either.right if everything is okay

  25. final def wait(): Unit

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

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

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

  27. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped