AvroName

vulcan.generic.AvroName
final class AvroName(val name: String) extends StaticAnnotation

Annotation which can be used to alter the record name in derived schemas.

The annotation can be used in the following situations.

  • Annotate a type for enum name when using deriveEnum.
  • Annotate a type for fixed name when using deriveFixed.
  • Annotate a case class for record name when using Codec.derive from the generic module.
  • Annotate a case class parameter for record field name when using Codec.derive from the generic module.

Attributes

Graph
Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Concrete fields

final val name: String