Annotation Interface Http.QueryParam

Enclosing class:

Http

@Target({PARAMETER,RECORD_COMPONENT})
@Retention(CLASS)
@Documented
@Qualifier
public static @interface Http.QueryParam

Inject query parameter into a method parameter.

Can also be used on Http.RequestParams record components.

Declarative server endpoints support List<T> for mandatory multi-value query parameters and Optional<List<T>> for optional multi-value query parameters. A mandatory list is rejected when the named query parameter is missing, while an optional list is empty when the named query parameter is missing. If the query parameter name is present without any values, the injected list is empty.

Declarative clients send every value from List<T> and send Optional<List<T>> only when the optional is present.

Declarative client values must not be null. Use Optional.empty() to omit optional values. Client list values must not contain null elements.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	Name of the query parameter.

Element Details

value

String value

Name of the query parameter.

Returns:

name of the query parameter