iglu-core/com.snowplowanalytics.iglu.core

com.snowplowanalytics.iglu.core

package com.snowplowanalytics.iglu.core

Type members

Classlikes

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.

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

Companion:
object
object ParseError
Companion:
class
final case class PartialSchemaKey(vendor: String, name: String, format: String, version: SchemaVer)

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.

Companion:
object
object PartialSchemaKey

Companion object, which contains a custom constructor for PartialSchemaKey.

Companion object, which contains a custom constructor for PartialSchemaKey.

Companion:
class
final case class SchemaCriterion(vendor: String, name: String, format: String, model: Option[Int], revision: Option[Int], addition: Option[Int])

Filter self-describing schemas by SchemaKey.

Filter self-describing schemas by SchemaKey.

Companion:
object
object SchemaCriterion

Companion object, which contains custom constructors for SchemaCriterion.

Companion object, which contains custom constructors for SchemaCriterion.

Companion:
class
final case class SchemaKey(vendor: String, name: String, format: String, version: Full)

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.

Companion:
object
object SchemaKey

Companion object, which contains a custom constructor for SchemaKey.

Companion object, which contains a custom constructor for SchemaKey.

Companion:
class
final case class SchemaList extends AnyVal

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/schema-ddl. If the producer is Iglu Server, it's usually acceptable to trust the order.

Companion:
object
object SchemaList
Companion:
class
final case class SchemaMap(schemaKey: SchemaKey) extends AnyVal

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.

Companion:
object
object SchemaMap

Companion object, which contains a custom constructor for SchemaMap.

Companion object, which contains a custom constructor for SchemaMap.

Companion:
class
sealed trait SchemaVer

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.
Companion:
object
object SchemaVer
Companion:
class
final case class SelfDescribingData[D](schema: SchemaKey, data: D)

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.

Type parameters:
D

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

Value parameters:
data

The data blob itself.

schema

A reference to a self-describing schema.

Companion:
object
object SelfDescribingData
Companion:
class
final case class SelfDescribingSchema[S](self: SchemaMap, schema: S)

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.

Type parameters:
S

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

Value parameters:
schema

The schema itself.

self

Information about the schema.

Companion:
object
object SelfDescribingSchema
Companion:
class
sealed trait VersionKind

The kind of a component of a SchemaVer.

The kind of a component of a SchemaVer.

Companion:
object
object VersionKind
Companion:
class