Configuration Properties

Configuration properties for the gRPC starter project.

This page was generated by spring-configuration-property-documenter.

grpc-client-boot-autoconfigure

grpc.client.tls.key-manager

Class: grpcstarter.client.GrpcClientProperties$Tls$KeyManager

Key	Type	Description
cert-chain	org.springframework.core.io.Resource	@see TlsChannelCredentials.Builder#getCertificateChain()
private-key	org.springframework.core.io.Resource	@see TlsChannelCredentials.Builder#getPrivateKey()
private-key-password	java.lang.String	@see TlsChannelCredentials.Builder#getPrivateKeyPassword()

grpc.client.tls.trust-manager

Class: grpcstarter.client.GrpcClientProperties$Tls$TrustManager

Key	Type	Description	Default value	Deprecation
root-certs	org.springframework.core.io.Resource	@see TlsChannelCredentials.Builder#getRootCertificates()

grpc.client

Class: grpcstarter.client.GrpcClientProperties

Key	Type	Description	Default value
authority	java.lang.String	Default authority. <p> e.g. localhost:8080 </p>
base-packages	java.util.List<java.lang.String>	Base packages to scan for gRPC stubs. <p> This value will merge with {@link EnableGrpcClients#basePackages}, only takes effect if {@link EnableGrpcClients#basePackages} is not set. </p> <p> The advantage of using configuration is no need to introduce external annotations. </p>
channels	java.util.List<grpcstarter.client.GrpcClientProperties$Channel>	Channels configuration.
compression	java.lang.String	Compression configuration. @see AbstractStub#withCompression(String)
deadline	java.lang.Long	Deadline after in milliseconds, default value is 5000. @see AbstractStub#withDeadline(Deadline) @since 3.2.0
enabled	java.lang.Boolean	Whether to enable gRPC client autoconfiguration, default true.	true
max-inbound-message-size	org.springframework.util.unit.DataSize	Default max inbound message size, default value is 4MB. @see DataSize @see GrpcUtil#DEFAULT_MAX_MESSAGE_SIZE
max-inbound-metadata-size	org.springframework.util.unit.DataSize	Default max metadata size, default value is 8KB. @see DataSize @see GrpcUtil#DEFAULT_MAX_HEADER_LIST_SIZE
max-outbound-message-size	org.springframework.util.unit.DataSize	Default max outbound message size. @see DataSize @see AbstractStub#withMaxOutboundMessageSize(int)
metadata	java.util.List<grpcstarter.client.GrpcClientProperties$Metadata>	Default metadata will be added to all the gRPC requests.
shutdown-timeout	java.lang.Long	Channel shutdown timeout in milliseconds, default value is 5000.	5000
warn-unused-config-enabled	java.lang.Boolean	Whether to enable warn unused config, default true.	true

grpc.client.in-process

Class: grpcstarter.client.GrpcClientProperties$InProcess

Key	Type	Description	Default value	Deprecation
name	java.lang.String	In-process client name. <p> If set, will create an in-process channel by default, usually for testing. </p>

grpc.client.refresh

Class: grpcstarter.client.GrpcClientProperties$Refresh

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	Whether to enable refresh grpc clients, default false. <p> NOTE: this feature needs 'spring-cloud-context' dependency in the classpath. </p>	false

grpc.client.retry

Class: grpcstarter.client.GrpcClientProperties$Retry

Key	Type	Description
enabled	java.lang.Boolean	Whether to enable retry. @see io.grpc.ManagedChannelBuilder#enableRetry() @see io.grpc.ManagedChannelBuilder#disableRetry()
max-retry-attempts	java.lang.Integer	Maximum number of attempts to retry. @see io.grpc.ManagedChannelBuilder#maxRetryAttempts(int)
per-rpc-buffer-limit	org.springframework.util.unit.DataSize	The maximum number of retry buffer entries per RPC. @see io.grpc.ManagedChannelBuilder#perRpcBufferLimit(long)
retry-buffer-size	org.springframework.util.unit.DataSize	The maximum number of retry buffer entries. @see io.grpc.ManagedChannelBuilder#retryBufferSize(long)

grpc.client.tls

Class: grpcstarter.client.GrpcClientProperties$Tls

Key	Type	Description	Default value	Deprecation

grpc-server-boot-autoconfigure

grpc.server.tls.key-manager

Class: grpcstarter.server.GrpcServerProperties$Tls$KeyManager

Key	Type	Description	Default value	Deprecation
cert-chain	org.springframework.core.io.Resource
private-key	org.springframework.core.io.Resource
private-key-password	java.lang.String

grpc.server.tls.trust-manager

Class: grpcstarter.server.GrpcServerProperties$Tls$TrustManager

Key	Type	Description	Default value	Deprecation
root-certs	org.springframework.core.io.Resource

grpc.server.health.datasource

Class: grpcstarter.server.GrpcServerProperties$Health$DataSource

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean
service	java.lang.String
timeout	java.lang.Integer
validation-query	java.lang.String

grpc.server.health.redis

Class: grpcstarter.server.GrpcServerProperties$Health$Redis

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean
service	java.lang.String

grpc.server

Class: grpcstarter.server.GrpcServerProperties

Key	Type	Description	Default value	Deprecation
enable-empty-server	java.lang.Boolean
enabled	java.lang.Boolean
max-inbound-message-size	org.springframework.util.unit.DataSize
max-inbound-metadata-size	org.springframework.util.unit.DataSize
port	java.lang.Integer
shutdown-timeout	java.lang.Long

grpc.server.channelz

Class: grpcstarter.server.GrpcServerProperties$Channelz

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean
max-page-size	java.lang.Integer

grpc.server.exception-handling

Class: grpcstarter.server.GrpcServerProperties$ExceptionHandling

Key	Type	Description	Default value	Deprecation
default-exception-advice-enabled	java.lang.Boolean
enabled	java.lang.Boolean

grpc.server.health

Class: grpcstarter.server.GrpcServerProperties$Health

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean

grpc.server.in-process

Class: grpcstarter.server.GrpcServerProperties$InProcess

Key	Type	Description	Default value	Deprecation
name	java.lang.String

grpc.server.reflection

Class: grpcstarter.server.GrpcServerProperties$Reflection

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean

grpc.server.response

Class: grpcstarter.server.GrpcServerProperties$Response

Key	Type	Description	Default value	Deprecation
max-description-length	java.lang.Integer

grpc.server.tls

Class: grpcstarter.server.GrpcServerProperties$Tls

Key	Type	Description	Default value	Deprecation

grpc-metrics

grpc.metrics

Class: grpcstarter.extensions.metrics.GrpcMetricsProperties

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	whether to enable metrics, default is {@code true}	true

grpc.metrics.client

Class: grpcstarter.extensions.metrics.GrpcMetricsProperties$Client

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	whether to enable client metrics, default is {@code true}	true
order	java.lang.Integer	The order of the client metrics interceptor. Default is {@code 0}.	0

grpc.metrics.server

Class: grpcstarter.extensions.metrics.GrpcMetricsProperties$Server

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	whether to enable server metrics, default is {@code true}	true
order	java.lang.Integer	The order of the server metrics interceptor. Default is {@code 0}.	0

grpc-test

grpc.test

Class: grpcstarter.extensions.test.GrpcTestProperties

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	Whether to enable test, default is {@code true}.	true

grpc.test.server

Class: grpcstarter.extensions.test.GrpcTestProperties$Server

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	Whether to enable test, default is {@code true}.	true
port-type	grpcstarter.extensions.test.GrpcTestProperties$PortType	Port configuration, default is {@link PortType#IN_PROCESS}, which means start grpc server with in-process transport. @see PortType

grpc-tracing

grpc.tracing

Class: grpcstarter.extensions.tracing.GrpcTracingProperties

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	whether to enable tracing, default is {@code true}	true

grpc.tracing.client

Class: grpcstarter.extensions.tracing.GrpcTracingProperties$Client

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	whether to enable client tracing, default is {@code true}	true
order	java.lang.Integer	The order of the client tracing interceptor. Default is {@code 0}.	0

grpc.tracing.server

Class: grpcstarter.extensions.tracing.GrpcTracingProperties$Server

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	whether to enable server tracing, default is {@code true}	true
order	java.lang.Integer	The order of the server tracing interceptor. Default is {@code 0}.	0

grpc-transcoding

grpc.transcoding

Class: grpcstarter.extensions.transcoding.GrpcTranscodingProperties

Key	Type	Description	Default value	Deprecation
auto-mapping	java.lang.Boolean
enabled	java.lang.Boolean
endpoint	java.lang.String

grpc.transcoding.print-options

Class: grpcstarter.extensions.transcoding.GrpcTranscodingProperties$PrintOptions

Key	Type	Description	Default value	Deprecation
add-whitespace	java.lang.Boolean
always-print-enums-as-ints	java.lang.Boolean

grpc-validation

grpc.validation

Class: grpcstarter.extensions.validation.GrpcValidationProperties

Key	Type	Description	Default value	Deprecation
backend	grpcstarter.extensions.validation.GrpcValidationProperties$Backend	Validation implementation.
enabled	java.lang.Boolean	Whether to enable validation, default is {@code true}.	true

grpc.validation.client

Class: grpcstarter.extensions.validation.GrpcValidationProperties$Client

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	Whether to enable validation, default is {@code true}.	true
order	java.lang.Integer	Validating interceptor order, default is {@code 0}.	0

grpc.validation.server

Class: grpcstarter.extensions.validation.GrpcValidationProperties$Server

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean	Whether to enable validation, default is {@code true}.	true
order	java.lang.Integer	Validating interceptor order, default is {@code 0}.	0

This is a generated file, generated at: 2024-08-20T22:49:57.226256

Configuration Properties

Table of Contents​

grpc-client-boot-autoconfigure​

grpc.client.tls.key-manager​

grpc.client.tls.trust-manager​

grpc.client​

grpc.client.in-process​

grpc.client.refresh​

grpc.client.retry​

grpc.client.tls​

grpc-server-boot-autoconfigure​

grpc.server.tls.key-manager​

grpc.server.tls.trust-manager​

grpc.server.health.datasource​

grpc.server.health.redis​

grpc.server​

grpc.server.channelz​

grpc.server.exception-handling​

grpc.server.health​

grpc.server.in-process​

grpc.server.reflection​

grpc.server.response​

grpc.server.tls​

grpc-metrics​

grpc.metrics​

grpc.metrics.client​

grpc.metrics.server​

grpc-test​

grpc.test​

grpc.test.server​

grpc-tracing​

grpc.tracing​

grpc.tracing.client​

grpc.tracing.server​

grpc-transcoding​

grpc.transcoding​

grpc.transcoding.print-options​

grpc-validation​

grpc.validation​

grpc.validation.client​

grpc.validation.server​

Table of Contents