Annotation Type QueryParam

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean commaSeparatedList
      Set to true for parameters that are in comma-separated format, so that they will be split before parsing the individual values.
      java.lang.String value
      An optional field name to use for reading the query parameter from the Finagle HTTP Request.
    • Element Detail

      • value

        java.lang.String value
        An optional field name to use for reading the query parameter from the Finagle HTTP Request. When empty, the annotated case class field name will be used to read the query parameter from the Finagle HTTP Request parameters.
        Returns:
        the name of the query parameter field.
        Default:
        ""
      • commaSeparatedList

        boolean commaSeparatedList
        Set to true for parameters that are in comma-separated format, so that they will be split before parsing the individual values. Only meaningful for collections. This makes it easy to support the query param styles from RFC-6570 (URI Template) Section 3.2.8 https://tools.ietf.org/html/rfc6570#section-3.2.8 These styles use the modifiers defined elsewhere in the spec, especially the "explode modifier" defined in Section 2.4.2 https://tools.ietf.org/html/rfc6570#section-2.4.2 commaSeparatedList == false corresponds to the "explode modifier" style {&list*} &list=red&list=green&list=blue commaSeparatedList == true corresponds to the non-"explode modifier" style: {&list} &list=red,green,blue
        Default:
        false