Configuration Properties

Configuration properties for the gRPC starter project.

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

grpc-client-boot-autoconfigure
grpc-server-boot-autoconfigure
grpc-metrics
grpc-test
- grpc.test - grpcstarter.extensions.test.GrpcTestProperties
- grpc.test.server - grpcstarter.extensions.test.GrpcTestProperties$Server
grpc-tracing
grpc-transcoding
- grpc.transcoding - grpcstarter.extensions.transcoding.GrpcTranscodingProperties
- grpc.transcoding.print-options - grpcstarter.extensions.transcoding.GrpcTranscodingProperties$PrintOptions
grpc-validation

grpc-client-boot-autoconfigure

grpc.client

Class: grpcstarter.client.GrpcClientProperties

Key	Type	Description	Default value	Deprecation
authority	java.lang.String
base-packages	java.util.List<java.lang.String>
bean-definition-handler	java.lang.Class<? extends grpcstarter.client.GrpcClientBeanDefinitionHandler>
channels	java.util.List<grpcstarter.client.GrpcClientProperties$Channel>
clients	java.util.List<java.lang.Class<? extends io.grpc.stub.AbstractStub>>
compression	java.lang.String
deadline	java.lang.Long
enabled	java.lang.Boolean
max-inbound-message-size	org.springframework.util.unit.DataSize
max-inbound-metadata-size	org.springframework.util.unit.DataSize
max-outbound-message-size	org.springframework.util.unit.DataSize
metadata	java.util.List<grpcstarter.client.GrpcClientProperties$Metadata>
shutdown-timeout	java.lang.Long
ssl-bundle	java.lang.String

grpc.client.in-process

Class: grpcstarter.client.GrpcClientProperties$InProcess

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

grpc.client.refresh

Class: grpcstarter.client.GrpcClientProperties$Refresh

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

grpc.client.retry

Class: grpcstarter.client.GrpcClientProperties$Retry

Key	Type	Description	Default value	Deprecation
enabled	java.lang.Boolean
max-retry-attempts	java.lang.Integer
per-rpc-buffer-limit	org.springframework.util.unit.DataSize
retry-buffer-size	org.springframework.util.unit.DataSize

grpc-server-boot-autoconfigure

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

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
ssl-bundle	java.lang.String

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-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	in-process

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
auto-mapping	java.lang.Boolean	Whether to route methods without the `google.api.http` option, default true. <p> Example: <pre>{@code package bookstore; service Bookstore { rpc GetShelf(GetShelfRequest) returns (Shelf) {} } message GetShelfRequest { int64 shelf = 1; } message Shelf {} }</pre> <p> The client could `post` a json body `{"shelf": 1234}` with the path of `/bookstore.Bookstore/GetShelfRequest` to call `GetShelfRequest`.	true
enabled	java.lang.Boolean	Whether to enable transcoding autoconfiguration, default {@code true}.	true
endpoint	java.lang.String	gRPC server endpoint, if not set, will use {@code localhost:${grpc.server.port}}. <p> In most cases, do not need to set this property explicitly.

grpc.transcoding.print-options

Class: grpcstarter.extensions.transcoding.GrpcTranscodingProperties$PrintOptions

Key	Type	Description	Default value	Deprecation
add-whitespace	java.lang.Boolean	Whether to add spaces, line breaks and indentation to make the JSON output easy to read. Defaults to false.	false
always-print-enums-as-ints	java.lang.Boolean	Whether to always print enums as ints. By default they are rendered as strings. Defaults to false.	false

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

Table of Contents​

grpc-client-boot-autoconfigure​

grpc.client​

grpc.client.in-process​

grpc.client.refresh​

grpc.client.retry​

grpc-server-boot-autoconfigure​

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