Interface HttpAnnotated
- All Superinterfaces:
ModelElement,Prototype.Api
- All Known Subinterfaces:
ClientEndpoint,RestEndpoint,RestMethod,ServerEndpoint
- All Known Implementing Classes:
ClientEndpoint.BuilderBase.ClientEndpointImpl,HttpAnnotated.BuilderBase.HttpAnnotatedImpl,RestEndpoint.BuilderBase.RestEndpointImpl,RestMethod.BuilderBase.RestMethodImpl,ServerEndpoint.BuilderBase.ServerEndpointImpl
An element that is annotation within the HTTP REST handling.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classFluent API builder forHttpAnnotated.static classHttpAnnotated.BuilderBase<BUILDER extends HttpAnnotated.BuilderBase<BUILDER,PROTOTYPE>, PROTOTYPE extends HttpAnnotated> Fluent API builder base forHttpAnnotated. -
Method Summary
Modifier and TypeMethodDescriptionstatic HttpAnnotated.Builderbuilder()Create a new fluent API builder to customize configuration.static HttpAnnotated.Builderbuilder(HttpAnnotated instance) Create a new fluent API builder from an existing instance.List of computed header values.consumes()List of consumed media types (from server endpoint point of view).headers()List of configured header values.path()Path of the endpoint/method (optional).produces()List of produced media types (from server endpoint point of view).Methods inherited from interface io.helidon.declarative.codegen.model.http.ModelElement
annotations, type
-
Method Details
-
builder
Create a new fluent API builder to customize configuration.- Returns:
- a new builder
-
builder
Create a new fluent API builder from an existing instance.- Parameters:
instance- an existing instance used as a base for the builder- Returns:
- a builder based on an instance
-
produces
List of produced media types (from server endpoint point of view).- Returns:
- media types
-
consumes
List of consumed media types (from server endpoint point of view).- Returns:
- media types
-
headers
List<HeaderValue> headers()List of configured header values.- Returns:
- header values
-
computedHeaders
List<ComputedHeader> computedHeaders()List of computed header values.- Returns:
- computed header values
-
path
Path of the endpoint/method (optional).- Returns:
- endpoint/method path
-