Module io.helidon.declarative.codegen.model

Package io.helidon.declarative.codegen.model.http

Interface ClientEndpoint

All Superinterfaces:

HttpAnnotated, ModelElement, Prototype.Api, RestEndpoint

All Known Implementing Classes:

ClientEndpoint.BuilderBase.ClientEndpointImpl

public interface ClientEndpoint
extends Prototype.Api, RestEndpoint, HttpAnnotated, ModelElement

Rest endpoint for Typed HTTP client.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ClientEndpoint.Builder	Fluent API builder for ClientEndpoint.
static class	ClientEndpoint.BuilderBase<BUILDER extends ClientEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClientEndpoint>	Fluent API builder base for ClientEndpoint.

Method Summary

Modifier and Type	Method	Description
static ClientEndpoint.Builder	builder()	Create a new fluent API builder to customize configuration.
static ClientEndpoint.Builder	builder(ClientEndpoint instance)	Create a new fluent API builder from an existing instance.
Optional<String>	clientName()	Name of a web client that should be injected and used by the generated typed client.
String	configKey()	Configuration key to use at runtime.
static ClientEndpoint	create()	Create a new instance with default values.
String	uri()	Configured URI.

Methods inherited from interface io.helidon.declarative.codegen.model.http.HttpAnnotated

computedHeaders, consumes, headers, path, produces

Methods inherited from interface io.helidon.declarative.codegen.model.http.ModelElement

annotations, type

Methods inherited from interface io.helidon.declarative.codegen.model.http.RestEndpoint

methods

Method Details

builder

static ClientEndpoint.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ClientEndpoint.Builder builder(ClientEndpoint instance)

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

static ClientEndpoint create()

Create a new instance with default values.

Returns:

a new instance

uri

String uri()

Configured URI.

Returns:

URI if configured

configKey

String configKey()

Configuration key to use at runtime.

Returns:

configuration key to override annotation based values

clientName

Optional<String> clientName()

Name of a web client that should be injected and used by the generated typed client.

Returns:

rest client name