Interface ServerEndpoint
- All Superinterfaces:
HttpAnnotated,ModelElement,Prototype.Api,RestEndpoint
- All Known Implementing Classes:
ServerEndpoint.BuilderBase.ServerEndpointImpl
REST endpoint for server side endpoint definition.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classFluent API builder forServerEndpoint.static classServerEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>, PROTOTYPE extends ServerEndpoint> Fluent API builder base forServerEndpoint. -
Method Summary
Modifier and TypeMethodDescriptionstatic ServerEndpoint.Builderbuilder()Create a new fluent API builder to customize configuration.static ServerEndpoint.Builderbuilder(ServerEndpoint instance) Create a new fluent API builder from an existing instance.static ServerEndpointcreate()Create a new instance with default values.listener()Listener name (optional).booleanWhether the listener must be defined on the server or not.Methods inherited from interface io.helidon.declarative.codegen.model.http.HttpAnnotated
computedHeaders, consumes, headers, path, producesMethods inherited from interface io.helidon.declarative.codegen.model.http.ModelElement
annotations, typeMethods inherited from interface io.helidon.declarative.codegen.model.http.RestEndpoint
methods
-
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
-
create
Create a new instance with default values.- Returns:
- a new instance
-
listener
Listener name (optional).- Returns:
- listener this endpoint should be assigned to
-
listenerRequired
boolean listenerRequired()Whether the listener must be defined on the server or not. If required, server will fail to start if the listener is not configured.- Returns:
- whether the listener is required, defaults to
false
-