Module io.helidon.webserver.grpc

Package io.helidon.webserver.grpc

Interface GrpcConfig

All Superinterfaces:

NamedService, ProtocolConfig, Prototype.Api

All Known Implementing Classes:

GrpcConfig.BuilderBase.GrpcConfigImpl

public interface GrpcConfig
extends Prototype.Api

Interface generated from definition. Please add javadoc to the definition interface.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GrpcConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static GrpcConfig.Builder	builder(GrpcConfig instance)	Create a new fluent API builder from an existing instance.
static GrpcConfig	create()	Create a new instance with default values.
static GrpcConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static GrpcConfig	create(Config config)	Create a new instance from configuration.
boolean	enableCompression()	Whether to support compression if requested by a client.
boolean	enableMetrics()	Whether to collect metrics for gRPC server calls.
String	name()	Protocol configuration name.
String	type()	Protocol configuration type.

Method Details

builder

static GrpcConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static GrpcConfig.Builder builder(GrpcConfig 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 GrpcConfig 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 GrpcConfig 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 GrpcConfig create()

Create a new instance with default values.

Returns:

a new instance

name

String name()

Protocol configuration name.

Specified by:

name in interface NamedService

Returns:

name of this configuration

type

String type()

Protocol configuration type.

Specified by:

type in interface NamedService

Returns:

type of this configuration

enableMetrics

boolean enableMetrics()

Whether to collect metrics for gRPC server calls.

Returns:

metrics flag

enableCompression

boolean enableCompression()

Whether to support compression if requested by a client. If explicitly disabled, no compression will be ever be used by the server even if a client-compatible compressor is found.

Returns:

true if compression is enabled