Annotation Interface RpcClient.Endpoint

Enclosing class:

RpcClient

@Target(TYPE)
@Retention(CLASS)
@Documented
public static @interface RpcClient.Endpoint

Defines a declarative gRPC client endpoint.

Configuration options for gRPC clients (prefixed by configKey()):

gRPC Client Configuration Options

Key	Default Value	Description
client		Backing GrpcClient configuration. The endpoint URI is applied after this configuration.

In case key client node exists under the configuration node of this API, a new client will be created for this instance, using value() as its base URI (this always wins). In case the clientName() is defined, and an instance of that name is available in registry, it will be used for this instance. If the named client is not available, a new client will be created with value() as its base URI. When clientName() is not defined, we use an unnamed client instance from the registry (if any). The last resort is to create a new client with value() as its base URI.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	Target URI of the generated backing gRPC client.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	clientName	Name of a registry-provided GrpcClient to use.
String	configKey	Configuration key base to use when looking up options for the backing gRPC client.

Element Details

value

String value

Target URI of the generated backing gRPC client.

Supports configuration references, such as "http://localhost:${server.port}". This value is used as the base URI when the generated client creates a backing GrpcClient. Registry-provided clients keep their own base URI.

Returns:

target URI

configKey

String configKey

Configuration key base to use when looking up options for the backing gRPC client.

Returns:

configuration key prefix

Default:

""

clientName

String clientName

Name of a registry-provided GrpcClient to use.

Returns:

client name

Default:

""