Module io.helidon.webclient.grpc

Package io.helidon.webclient.grpc

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 GrpcClient.

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)	Deprecated. use create(io.helidon.config.Config)
static GrpcClientConfig	create(Config config)	Create a new instance from configuration.
default ClientRequestHeaders	defaultRequestHeaders()	Default headers as a headers object.
boolean	enableMetrics()	Whether to collect metrics for gRPC client calls.
List<GrpcClientService>	grpcServices()	gRPC client services.
GrpcClientProtocolConfig	protocolConfig()	gRPC specific configuration.

Methods inherited from interface io.helidon.webclient.api.HttpClientConfig

baseFragment, baseQuery, baseUri, connectionCacheSize, contentEncoding, cookieManager, defaultHeadersMap, dnsAddressLookup, dnsResolver, executor, headers, maxInMemoryEntity, mediaContext, mediaSupports, mediaTypeParserMode, readContinueTimeout, relativeUris, sendExpectContinue, services, shareConnectionCache, socketOptions, writeBufferSize

Methods inherited from interface io.helidon.webclient.api.HttpConfigBase

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

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

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

@Deprecated
static GrpcClientConfig create(Config config)

Deprecated.

use create(io.helidon.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

grpcServices

List<GrpcClientService> grpcServices()

gRPC client services. A gRPC service needs to be explicitly added to be enabled given that discoveredServices is false.

Returns:

services to use with this gRPC client

defaultRequestHeaders

default ClientRequestHeaders defaultRequestHeaders()

Default headers as a headers object. Creates a new instance for each call, so the returned value can be safely mutated.

Returns:

default headers