io.micronaut.http.client.annotation

Annotation Type Client

@Documented
 @Retention(value=RUNTIME)
 @Introduction
 @Type(value=HttpClientIntroductionAdvice.class)
 @Recoverable
 @Singleton
public @interface Client

Allows defining declarative HTTP clients and customizing injection for injecting HttpClient implementations.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends HttpClientConfiguration>	configuration
java.lang.Class<?>	errorType
HttpVersion	httpVersion The HTTP version.
java.lang.String	id
java.lang.String	path The base URI for the client.
java.lang.String	value

Element Detail

value

@AliasFor(member="id")
public abstract java.lang.String value

Returns:

The URL or service ID of the remote service

Default:

""

id

@AliasFor(member="value")
public abstract java.lang.String id

Returns:

The ID of the client

Default:

""

path

public abstract java.lang.String path

The base URI for the client. Only to be used in conjunction with id().

Returns:

The base URI

Default:

""

errorType

public abstract java.lang.Class<?> errorType

Returns:

The type used to decode errors

Default:

io.micronaut.http.hateoas.JsonError.class

configuration

public abstract java.lang.Class<? extends HttpClientConfiguration> configuration

Returns:

The http client configuration bean to use

Default:

io.micronaut.http.client.HttpClientConfiguration.class

httpVersion

public abstract HttpVersion httpVersion

The HTTP version.

Returns:

The HTTP version of the client.

Default:

io.micronaut.http.HttpVersion.HTTP_1_1