Interface GrpcClientConfig

All Superinterfaces:

HttpClientConfig, HttpConfigBase, Prototype.Api, Prototype.Factory<GrpcClient>

All Known Implementing Classes:

GrpcClientConfig.BuilderBase.GrpcClientConfigImpl

public interface GrpcClientConfig
extends Prototype.Api, HttpClientConfig

Configuration of a grpc client.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GrpcClientConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static GrpcClientConfig.Builder	builder(GrpcClientConfig instance)	Create a new fluent API builder from an existing instance.
Optional<ClientUriSupplier>	clientUriSupplier()	A ClientUriSupplier that can dynamically provide zero or more ClientUris to connect.
static GrpcClientConfig	create()	Create a new instance with default values.
static GrpcClientConfig	create(Config config)	Create a new instance from configuration.
boolean	enableMetrics()	Whether to collect metrics for gRPC client calls.
List<GrpcClientService>	grpcServices()	gRPC client services.
default Optional<MeterRegistry>	meterRegistry()	Meter registry to use for gRPC client metrics.
GrpcClientProtocolConfig	protocolConfig()	gRPC specific configuration.

Methods inherited from interface HttpClientConfig

altSvc, baseAddress, baseFragment, baseQuery, baseUri, connectionCacheSize, connectionListener, contentEncoding, cookieManager, defaultHeadersMap, defaultRequestHeaders, dnsAddressLookup, dnsResolver, executor, filterRedirectHeaders, followCrossOriginEntityRedirects, headers, maxInMemoryEntity, mediaContext, mediaSupports, mediaTypeParserMode, readContinueTimeout, redirectSensitiveHeaders, relativeUris, sendExpectContinue, services, shareConnectionCache, sni, socketOptions, writeBufferSize

Modifier and Type	Method	Description
Optional<ClientAltSvcConfig>	altSvc()	Client policy for accepting and using HTTP Alt-Svc response advertisements.
Optional<SocketAddress>	baseAddress()	Base address used by the client in all requests.
Optional<UriFragment>	baseFragment()	Base fragment used by the client in all requests (unless overwritten on per-request basis).
Optional<UriQuery>	baseQuery()	Base query used by the client in all requests.
Optional<ClientUri>	baseUri()	Base uri used by the client in all requests.
int	connectionCacheSize()	Maximum number of reusable physical connections each HTTP protocol retains for a single connection target.
ConnectionListener	connectionListener()	Socket lifecycle callbacks.
ContentEncodingContext	contentEncoding()	Configure the listener specific ContentEncodingContext.
Optional<WebClientCookieManager>	cookieManager()	WebClient cookie manager.
Map<String,String>	defaultHeadersMap()	Default headers to be used in every request from configuration.
default ClientRequestHeaders	defaultRequestHeaders()	Default headers as a headers object.
DnsAddressLookup	dnsAddressLookup()	DNS address lookup preferences to be used by this client.
DnsResolver	dnsResolver()	DNS resolver to be used by this client.
ExecutorService	executor()	Client executor service.
boolean	filterRedirectHeaders()	Whether headers sensitive to cross-origin redirects should be filtered before the redirected request is sent.
boolean	followCrossOriginEntityRedirects()	Whether redirects that preserve request method and entity may be followed across origins.
Set<Header>	headers()	Default headers to be used in every request.
int	maxInMemoryEntity()	If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance.
MediaContext	mediaContext()	Configure the listener specific MediaContext.
List<MediaSupport>	mediaSupports()	Media supports (manually added).
ParserMode	mediaTypeParserMode()	Configure media type parsing mode for HTTP Content-Type header.
Duration	readContinueTimeout()	Socket 100-Continue read timeout.
Set<HeaderName>	redirectSensitiveHeaders()	Request header names to strip on cross-origin redirects.
boolean	relativeUris()	Can be set to true to force the use of relative URIs in all requests, regardless of the presence or absence of proxies or no-proxy lists.
boolean	sendExpectContinue()	Whether Expect-100-Continue header is sent to verify server availability before sending an entity.
List<WebClientService>	services()	WebClient services.
boolean	shareConnectionCache()	Whether to use protocol-specific JVM-wide connection caches shared by compatible WebClient instances.
Optional<SniConfig>	sni()	Client-side TLS SNI configuration.
SocketOptions	socketOptions()	Socket options for connections opened by this client.
int	writeBufferSize()	Buffer size used when writing data to the underlying socket on a client TCP connection.

Methods inherited from interface HttpConfigBase

connectTimeout, followRedirects, keepAlive, maxRedirects, properties, proxy, readTimeout, tls

Modifier and Type	Method	Description
Optional<Duration>	connectTimeout()	Connect timeout.
boolean	followRedirects()	Whether to follow redirects.
boolean	keepAlive()	Determines if connection keep alive is enabled (NOT socket keep alive, but HTTP connection keep alive, to re-use the same connection for multiple requests).
int	maxRedirects()	Max number of followed redirects.
Map<String,String>	properties()	Properties configured for this client.
Proxy	proxy()	Proxy configuration to be used for requests.
Optional<Duration>	readTimeout()	Read timeout.
Tls	tls()	TLS configuration for any TLS request from this client.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
GrpcClient	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static GrpcClientConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static GrpcClientConfig.Builder builder(GrpcClientConfig 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 GrpcClientConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static GrpcClientConfig create()

Create a new instance with default values.

Returns:

a new instance

protocolConfig

GrpcClientProtocolConfig protocolConfig()

gRPC specific configuration.

Returns:

protocol specific configuration

clientUriSupplier

Optional<ClientUriSupplier> clientUriSupplier()

A ClientUriSupplier that can dynamically provide zero or more ClientUris to connect.

Returns:

a supplier for zero or more client URIs

enableMetrics

boolean enableMetrics()

Whether to collect metrics for gRPC client calls.

Returns:

metrics flag

meterRegistry

default Optional<MeterRegistry> meterRegistry()

Meter registry to use for gRPC client metrics.

Returns:

meter registry to use

grpcServices

List<GrpcClientService> grpcServices()

gRPC client services. Services are discovered automatically by default.

Returns:

services to use with this gRPC client