case class RouteSpec extends Product with Serializable

Encapsulates the specification of an HTTP endpoint, for use by either a Finagle server or client.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RouteSpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 at(method: Method): UnboundRoute0
  6. def body(bp: Body[_]): RouteSpec

    Register the expected content of the body.

  7. val body: Option[Body[_]]
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val consumes: Set[ContentType]
  10. def consuming(contentTypes: ContentType*): RouteSpec

    Register content types which the route will consume.

    Register content types which the route will consume. This is informational only and is NOT currently enforced.

  11. val description: Option[String]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  19. val produces: Set[ContentType]
  20. def producing(contentTypes: ContentType*): RouteSpec

    Register content types which thus route will produce.

    Register content types which thus route will produce. This is informational only and NOT currently enforced.

  21. val requestParams: Seq[QueryOrHeader[_]]
  22. val responses: Map[Status, ResponseSpec]
  23. def returning(codeAndReason: (Status, String), example: String): RouteSpec

    Register a possible response which could be produced by this route, with an example body (used for schema generation).

  24. def returning[T](codeAndReason: (Status, String), example: T, jsonLib: JsonLibrary[T, _] = Argo): RouteSpec

    Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).

  25. def returning(response: Response): RouteSpec

    Register an exact possible response which could be produced by this route.

    Register an exact possible response which could be produced by this route. Will be used for schema generation if content is JSON.

  26. def returning(codesAndReasons: (Status, String)*): RouteSpec

    Register one or more possible responses which could be produced by this route.

  27. def returning(newResponse: ResponseSpec): RouteSpec

    Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).

  28. val summary: String
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def taggedWith(tags: TagInfo*): RouteSpec

    Add tags to this routes.

    Add tags to this routes. Provides the ability to group routes by tag in a generated schema.

  31. def taggedWith(tag: String): RouteSpec

    Add tags to this routes.

    Add tags to this routes. Provides the ability to group routes by tag in a generated schema.

  32. val tags: Set[TagInfo]
  33. def taking(rp: QueryOrHeader[_]): RouteSpec

    Register a header/query parameter.

    Register a header/query parameter. Mandatory parameters are checked for each request, and a 400 returned if any are missing.

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped