org.mashupbots.socko.rest

HeaderParam

case class HeaderParam(name: String, description: String = "", headerName: String = "", allowMultiple: Boolean = false, allowableValues: Option[AllowableValues] = scala.None) extends RequestParam with Product with Serializable

Parameter that binds to a value in the header

name

Name of the request parameter

description

Short description of the parameter

headerName

Name of the header field. If empty (default), then the header field name is assumed to be the same as name.

allowMultiple

Specifies that a comma-separated list of values can be passed. Defaults to false.

allowableValues

Input validation

Linear Supertypes
Serializable, Serializable, Product, Equals, RequestParam, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HeaderParam
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RequestParam
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HeaderParam(name: String, description: String = "", headerName: String = "", allowMultiple: Boolean = false, allowableValues: Option[AllowableValues] = scala.None)

    name

    Name of the request parameter

    description

    Short description of the parameter

    headerName

    Name of the header field. If empty (default), then the header field name is assumed to be the same as name.

    allowMultiple

    Specifies that a comma-separated list of values can be passed. Defaults to false.

    allowableValues

    Input validation

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. val allowMultiple: Boolean

    Specifies that a comma-separated list of values can be passed.

    Specifies that a comma-separated list of values can be passed. Defaults to false.

    Definition Classes
    HeaderParamRequestParam
  7. val allowableValues: Option[AllowableValues]

    Input validation

    Input validation

    Definition Classes
    HeaderParamRequestParam
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val description: String

    Short description of the parameter

    Short description of the parameter

    Definition Classes
    HeaderParamRequestParam
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  14. val headerName: String

    Name of the header field.

    Name of the header field. If empty (default), then the header field name is assumed to be the same as name.

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. val name: String

    Name of the request parameter

    Name of the request parameter

    Definition Classes
    HeaderParamRequestParam
  17. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  20. val paramType: String

    Definition Classes
    HeaderParamRequestParam
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  22. final def wait(): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. 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 RequestParam

Inherited from AnyRef

Inherited from Any

Ungrouped