Trait/Object

com.snowplowanalytics.iglu.client.resolver.registries

RegistryLookup

Related Docs: object RegistryLookup | package registries

Permalink

trait RegistryLookup[F[_]] extends AnyRef

A capability of F to communicate with Iglu registries, using RepositoryRef ADT, in order to lookup for schemas or get schema lists

F

effect type, preferably referentially-transparent, but can be Id in case of distributed engine like Spark

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

Abstract Value Members

  1. abstract def list(registry: Registry, vendor: String, name: String, model: Int): F[Either[RegistryError, SchemaList]]

    Permalink

    List all schemas (formats and versions) for a given vendor/name pair in their chronological order.

    List all schemas (formats and versions) for a given vendor/name pair in their chronological order. It is up to Registry to build valid list

    registry

    one of supported repository types (only HTTP is supported)

    vendor

    precise schema vendor

    name

    schema name

    returns

    some parsed SchemaList (order is trusted) or none in any unexpected case

  2. abstract def lookup(registry: Registry, schemaKey: SchemaKey): F[Either[RegistryError, Json]]

    Permalink

    Find a schema in the particular RepositoryRef

    Find a schema in the particular RepositoryRef

    registry

    one of supported repository types

    schemaKey

    The SchemaKey uniquely identifying the schema in Iglu

    returns

    either schema parsed into Json or RegistryError, such as absent schema, or unexpected response

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 clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped