Annotation Type Consumes


  • @Documented
    @Retention(RUNTIME)
    @Target({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
    • Optional Element Summary

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

      • value

        java.lang.String[] value
        Returns:
        The MediaType values that this component is able to consume
        Default:
        {"application/json"}
      • single

        @AliasFor(annotation=io.micronaut.core.async.annotation.SingleResult.class,
                  member="value")
        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