Package io.micronaut.http.annotation
Annotation Type Put
-
@Documented @Retention(RUNTIME) @Target(METHOD) @HttpMethodMapping @Inherited public @interface Put
Annotation that can be applied to method to signify the method receives aHttpMethod.PUT
.- Since:
- 1.0
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String[]
consumes
java.lang.String[]
processes
Shortcut that allows setting both theconsumes()
andproduces()
settings to the same media type.java.lang.String[]
produces
boolean
single
java.lang.String
uri
java.lang.String[]
uris
Only to be used in the context of a server.java.lang.String
value
-
-
-
Element Detail
-
value
@AliasFor(annotation=HttpMethodMapping.class,member="value") @AliasFor(annotation=UriMapping.class,member="value") java.lang.String value
- Returns:
- The URI of the PUT route
- Default:
- "/"
-
-
-
uri
@AliasFor(annotation=HttpMethodMapping.class,member="value") @AliasFor(annotation=UriMapping.class,member="value") java.lang.String uri
- Returns:
- The URI of the PUT route
- Default:
- "/"
-
-
-
uris
@AliasFor(annotation=HttpMethodMapping.class,member="uris") @AliasFor(annotation=UriMapping.class,member="uris") java.lang.String[] uris
Only to be used in the context of a server.- Returns:
- The URIs of the PUT route
- Default:
- {"/"}
-
-
-
consumes
@AliasFor(annotation=Consumes.class, member="value") java.lang.String[] consumes
- Returns:
- The default consumes, otherwise override from controller
- Default:
- {}
-
-
-
produces
@AliasFor(annotation=Produces.class, member="value") java.lang.String[] produces
- Returns:
- The default produces, otherwise override from controller
- Default:
- {}
-
-
-
processes
@AliasFor(annotation=Produces.class,member="value") @AliasFor(annotation=Consumes.class,member="value") java.lang.String[] processes
Shortcut that allows setting both theconsumes()
andproduces()
settings to the same media type.- Returns:
- The media type this method processes
- Default:
- {}
-
-
-
single
@AliasFor(annotation=Produces.class,member="single") @AliasFor(annotation=Consumes.class,member="single") @AliasFor(annotation=io.micronaut.core.async.annotation.SingleResult.class,member="value") boolean single
- Returns:
- Whether a single or multiple items are produced/consumed
- Default:
- false
-
-