org.springframework.cloud.netflix.ribbon

Annotation Type RibbonClient

@Configuration(proxyBeanMethods=false)
 @Import(value=RibbonClientConfigurationRegistrar.class)
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface RibbonClient

Declarative configuration for a ribbon client. Add this annotation to any @Configuration and then inject a SpringClientFactory to access the client that is created.

Author:

Dave Syer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	configuration A custom @Configuration for the ribbon client.
String	name The name of the ribbon client, uniquely identifying a set of client resources, including a load balancer.
String	value Synonym for name (the name of the client).

Element Detail

value

public abstract String value

Synonym for name (the name of the client).

Returns:

name of the Ribbon client

See Also:

name()

Default:

""

name

public abstract String name

The name of the ribbon client, uniquely identifying a set of client resources, including a load balancer.

Returns:

name of the Ribbon client

Default:

""

configuration

public abstract Class<?>[] configuration

A custom @Configuration for the ribbon client. Can contain override @Bean definition for the pieces that make up the client, for instance ILoadBalancer, ServerListFilter, IRule.

Returns:

the custom Ribbon client configuration

See Also:

for the defaults

Default:

{}