Packages

sealed abstract class AvroSettings[F[_]] extends AnyRef

Describes how to create a KafkaAvroDeserializer and a KafkaAvroSerializer and which settings should be used. Settings are tailored for the Confluent Kafka Avro serializers and deserializers.

Use AvroSettings.apply to create an instance.

Source
AvroSettings.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AvroSettings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def createAvroDeserializer(isKey: Boolean): F[(KafkaAvroDeserializer, SchemaRegistryClient)]

    Creates a new KafkaAvroDeserializer using the settings contained within this AvroSettings instance, and the specified isKey flag, denoting whether a record key or value is being deserialized.

  2. abstract def createAvroSerializer(isKey: Boolean, writerSchema: Option[Schema]): F[(KafkaAvroSerializer, SchemaRegistryClient)]

    Creates a new KafkaAvroSerializer using the settings contained within this AvroSettings instance, and the specified isKey flag, denoting whether a record key or value is being serialized.

  3. abstract def properties: Map[String, String]

    Properties provided when creating a Confluent Kafka Avro serializer or deserializer.

    Properties provided when creating a Confluent Kafka Avro serializer or deserializer. Functions in AvroSettings add properties here as necessary.

  4. abstract def registerSchema[A](subject: String)(implicit codec: Codec[A]): F[Int]

    Register a schema for a given Codec for some type A, or return the existing schema id if it already exists.

    Register a schema for a given Codec for some type A, or return the existing schema id if it already exists.

    subject

    The subject name

    returns

    The schema id

  5. abstract def schemaRegistryClient: F[SchemaRegistryClient]

    The SchemaRegistryClient to use for the serializers and deserializers created from this AvroSettings.

  6. abstract def withAutoRegisterSchemas(autoRegisterSchemas: Boolean): AvroSettings[F]

    Creates a new AvroSettings instance with the specified setting for whether serializers should register schemas automatically or not.

    Creates a new AvroSettings instance with the specified setting for whether serializers should register schemas automatically or not.

    The default value is true.

  7. abstract def withCreateAvroDeserializer(createAvroDeserializerWith: (F[SchemaRegistryClient], Boolean, Map[String, String]) => F[(KafkaAvroDeserializer, SchemaRegistryClient)]): AvroSettings[F]

    Creates a new AvroSettings instance with the specified function for creating KafkaAvroDeserializers from settings.

    Creates a new AvroSettings instance with the specified function for creating KafkaAvroDeserializers from settings. The arguments are schemaRegistryClient, isKey, and properties.

  8. abstract def withCreateAvroSerializer(createAvroSerializerWith: (F[SchemaRegistryClient], Boolean, Option[Schema], Map[String, String]) => F[(KafkaAvroSerializer, SchemaRegistryClient)]): AvroSettings[F]

    Creates a new AvroSettings instance with the specified function for creating KafkaAvroSerializers from settings.

    Creates a new AvroSettings instance with the specified function for creating KafkaAvroSerializers from settings. The arguments are schemaRegistryClient, isKey, and properties.

  9. abstract def withKeySubjectNameStrategy(keySubjectNameStrategy: String): AvroSettings[F]

    Creates a new AvroSettings instance with the specified key subject name strategy.

    Creates a new AvroSettings instance with the specified key subject name strategy. This is the class name of the strategy which should be used.

    The default value is io.confluent.kafka.serializers.subject.TopicNameStrategy.

  10. abstract def withProperties(properties: Map[String, String]): AvroSettings[F]

    Creates a new AvroSettings instance including properties with the specified keys and values.

  11. abstract def withProperties(properties: (String, String)*): AvroSettings[F]

    Creates a new AvroSettings instance including properties with the specified keys and values.

  12. abstract def withProperty(key: String, value: String): AvroSettings[F]

    Creates a new AvroSettings instance including a property with the specified key and value.

  13. abstract def withRegisterSchema(registerSchemaWith: (F[SchemaRegistryClient], String, Codec[_]) => F[Int]): AvroSettings[F]

    Creates a new AvroSettings instance with the specified function for registering schemas from settings.

    Creates a new AvroSettings instance with the specified function for registering schemas from settings. The arguments are schemaRegistryClient, subject, and codec.

  14. abstract def withValueSubjectNameStrategy(valueSubjectNameStrategy: String): AvroSettings[F]

    Creates a new AvroSettings instance with the specified value subject name strategy.

    Creates a new AvroSettings instance with the specified value subject name strategy. This is the class name of the strategy which should be used.

    The default value is io.confluent.kafka.serializers.subject.TopicNameStrategy.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. final def createAvroSerializer(isKey: Boolean): F[(KafkaAvroSerializer, SchemaRegistryClient)]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0-M3) use the overload that takes an optional writer schema

  2. final def withCreateAvroSerializer(createAvroSerializerWith: (F[SchemaRegistryClient], Boolean, Map[String, String]) => F[(KafkaAvroSerializer, SchemaRegistryClient)]): AvroSettings[F]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0-M3) use the overload that has an Option[Schema] argument

Inherited from AnyRef

Inherited from Any

Ungrouped