Interface ClientEndpoint
- All Superinterfaces:
HttpAnnotated, ModelElement, Prototype.Api, RestEndpoint
- All Known Implementing Classes:
ClientEndpoint.BuilderBase.ClientEndpointImpl
Rest endpoint for Typed HTTP client.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classFluent API builder forClientEndpoint.static classClientEndpoint.BuilderBase<BUILDER extends ClientEndpoint.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ClientEndpoint>Fluent API builder base forClientEndpoint. -
Method Summary
Modifier and TypeMethodDescriptionstatic ClientEndpoint.Builderbuilder()Create a new fluent API builder to customize configuration.static ClientEndpoint.Builderbuilder(ClientEndpoint instance) Create a new fluent API builder from an existing instance.Name of a web client that should be injected and used by the generated typed client.Configuration key to use at runtime.uri()Configured URI.Methods inherited from interface HttpAnnotated
computedHeaders, consumes, headers, path, producesModifier and TypeMethodDescriptionList 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 ModelElement
annotations, typeModifier and TypeMethodDescriptionAll annotations on this element, and inherited from supertype/interface and annotations.type()Type of this element.Methods inherited from interface 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
-
uri
-
configKey
String configKey()Configuration key to use at runtime.- Returns:
- configuration key to override annotation based values
-
clientName
-