org.coursera.courier.companions

UnionWithTyperefCompanion

trait UnionWithTyperefCompanion extends UnionCompanion

Identifies companion objects of the Scala union "template" classes generated by Courier that were defined within a typeref and provides access to the typeref's schema.

Because the union is not a named type in Pegasus, it cannot have schema properties directly defied on it. As a result, the defining typeref is often used as an anchor for adding names and properties to unions.

For example, in:

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UnionWithTyperefCompanion
  2. UnionCompanion
  3. SchemaAware
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def SCHEMA: UnionDataSchema

    returns

    the data schema for the corresponding Courier type.

    Definition Classes
    UnionCompanionSchemaAware
  2. abstract def TYPEREF_SCHEMA: TyperefDataSchema

    returns

    the schema of the typeref that was used to define this union.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from UnionCompanion

Inherited from SchemaAware

Inherited from AnyRef

Inherited from Any

Ungrouped