io.micronaut.http.annotation

Annotation Type Consumes

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
 @Inherited
public @interface Consumes

An annotation to indicate the MediaTypes consumed by a particular component.

Generally with controllers one can use the consumes attribute of the Controller annotation, however this annotation is more generic and applies to any component

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	single Applies to clients that return reactive types.
String[]	value

Element Detail

value

public abstract String[] value

Returns:

The MediaType values that this component is able to consume

Default:

"application/json"

single

@AliasFor(annotation=SingleResult.class,
          member="value")
public abstract boolean single

Applies to clients that return reactive types.

This member indicates whether the response handling should stream or wait until the full response is read. Normally this annotation is unnecessary unless the declared type doesn't indicate how many items are emitted.

Returns:

True if only a single result is emitted

Default:

false