Packages

package core

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package circe
  2. package generated
  3. package json4s
  4. package typeclasses

Type Members

  1. sealed trait ParseError extends Product with Serializable

    A common error type for failures when parsing core Iglu entities, such as self-describing schema and self-describing data.

  2. final case class PartialSchemaKey(vendor: String, name: String, format: String, version: SchemaVer) extends Product with Serializable

    Contains details about the schema of a piece of self-describing data.

    Contains details about the schema of a piece of self-describing data.

    Unlike SchemaKey, the schema version may not be fully known.

  3. final case class SchemaCriterion(vendor: String, name: String, format: String, model: Option[Int] = None, revision: Option[Int] = None, addition: Option[Int] = None) extends Product with Serializable

    Filter self-describing schemas by SchemaKey.

  4. final case class SchemaKey(vendor: String, name: String, format: String, version: Full) extends Product with Serializable

    Contains details about the schema of a piece of self-describing data.

    Contains details about the schema of a piece of self-describing data.

    Provides the same information as a SchemaMap but is used when dealing with data, not schema.

    For an example, see typeclasses.ExtractSchemaKey.

    Unlike PartialSchemaKey, the schema version is always fully known.

  5. final case class SchemaList extends AnyVal with Product with Serializable

    A non-empty List of SchemaKeys, which belong to the same "vendor/name" OR "vendor/name/model" group.

    A non-empty List of SchemaKeys, which belong to the same "vendor/name" OR "vendor/name/model" group.

    Starts with the first schema in the series. The correct order can be validated by https://github.com/snowplow-incubator/schema-ddl. If the producer is Iglu Server, it's usually acceptable to trust the order.

  6. final case class SchemaMap(schemaKey: SchemaKey) extends AnyVal with Product with Serializable

    Contains details about a self-describing schema.

    Contains details about a self-describing schema.

    Provides the same information as a SchemaKey but is used when dealing with schema, not data.

    For an example, see typeclasses.ExtractSchemaMap.

  7. sealed trait SchemaVer extends AnyRef

    Semantic version for a self-describing schema.

    Semantic version for a self-describing schema.

    - model is the schema MODEL, representing a major schema version; - revision is the schema REVISION, representing backward-incompatible changes; - addition is the schema ADDITION, representing backward-compatible changes.

  8. final case class SelfDescribingData[D](schema: SchemaKey, data: D) extends Product with Serializable

    A container for self-describing data, used to eliminate the need for an Option wrapper when extracting a SchemaKey with the typeclasses.ExtractSchemaKey type class.

    A container for self-describing data, used to eliminate the need for an Option wrapper when extracting a SchemaKey with the typeclasses.ExtractSchemaKey type class.

    D

    Any generic type that can represent a piece of self-describing data. (See also typeclasses.ExtractSchemaKey.)

    schema

    A reference to a self-describing schema.

    data

    The data blob itself.

  9. final case class SelfDescribingSchema[S](self: SchemaMap, schema: S) extends Product with Serializable

    A container for a self-describing schema, used to eliminate the need for an Option wrapper when extracting a SchemaMap with the typeclasses.ExtractSchemaMap type class.

    A container for a self-describing schema, used to eliminate the need for an Option wrapper when extracting a SchemaMap with the typeclasses.ExtractSchemaMap type class.

    S

    Any generic type that can represent a self-describing schema. (See also typeclasses.ExtractSchemaMap.)

    self

    Information about the schema.

    schema

    The schema itself.

  10. sealed trait VersionKind extends AnyRef

    The kind of a component of a SchemaVer.

Value Members

  1. object ParseError extends Serializable
  2. object PartialSchemaKey extends Serializable

    Companion object, which contains a custom constructor for PartialSchemaKey.

  3. object SchemaCriterion extends Serializable

    Companion object, which contains custom constructors for SchemaCriterion.

  4. object SchemaKey extends Serializable

    Companion object, which contains a custom constructor for SchemaKey.

  5. object SchemaList extends Serializable
  6. object SchemaMap extends Serializable

    Companion object, which contains a custom constructor for SchemaMap.

  7. object SchemaVer
  8. object SelfDescribingData extends Serializable
  9. object SelfDescribingSchema extends Serializable
  10. object VersionKind

Ungrouped