Package io.quarkus.grpc.runtime.config

Class GrpcClientConfiguration

java.lang.Object

io.quarkus.grpc.runtime.config.GrpcClientConfiguration

public class GrpcClientConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	compression	The compression to use for each call.
Optional<Duration>	deadline	The deadline used for each call.
OptionalInt	flowControlWindow	The flow control window in bytes.
String	host	The host name / IP on which the service is exposed.
Optional<Duration>	idleTimeout	The duration without ongoing RPCs before going to idle mode.
Optional<Duration>	keepAliveTime	The duration after which a keep alive ping is sent.
Optional<Duration>	keepAliveTimeout	The amount of time the sender of of a keep alive ping waits for an acknowledgement.
boolean	keepAliveWithoutCalls	Whether keep-alive will be performed when there are no outstanding RPC on a connection.
String	loadBalancingPolicy	Use a custom load balancing policy.
int	maxHedgedAttempts	The max number of hedged attempts.
OptionalInt	maxInboundMessageSize	The maximum message size allowed for a single gRPC frame (in bytes).
OptionalInt	maxInboundMetadataSize	The maximum size of metadata allowed to be received (in bytes).
int	maxRetryAttempts	The max number of retry attempts.
OptionalInt	maxTraceEvents	The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.
String	negotiationType	The negotiation type for the HTTP/2 connection.
Optional<String>	overrideAuthority	Overrides the authority used with TLS and HTTP virtual hosting.
OptionalLong	perRpcBufferLimit	The per RPC buffer limit in bytes used for retry.
Optional<Boolean>	plainText	Whether plain-text should be used instead of TLS.
int	port	The gRPC service port.
boolean	retry	Whether retry is enabled.
OptionalLong	retryBufferSize	The retry buffer size in bytes.
SslClientConfig	ssl	The SSL/TLS config.
Optional<String>	userAgent	Use a custom user-agent.

Constructor Summary

Constructors

Constructor	Description
GrpcClientConfiguration()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

port

@ConfigItem(defaultValue="9000")
public int port

The gRPC service port.

host

@ConfigItem
public String host

The host name / IP on which the service is exposed.

ssl

public SslClientConfig ssl

The SSL/TLS config.

plainText

@ConfigItem
public Optional<Boolean> plainText

Whether plain-text should be used instead of TLS. Enables by default, except it TLS/SSL is configured. In this case, plain-text is disabled.

keepAliveTime

@ConfigItem
public Optional<Duration> keepAliveTime

The duration after which a keep alive ping is sent.

flowControlWindow

@ConfigItem
public OptionalInt flowControlWindow

The flow control window in bytes. Default is 1MiB.

idleTimeout

@ConfigItem
public Optional<Duration> idleTimeout

The duration without ongoing RPCs before going to idle mode.

keepAliveTimeout

@ConfigItem
public Optional<Duration> keepAliveTimeout

The amount of time the sender of of a keep alive ping waits for an acknowledgement.

keepAliveWithoutCalls

@ConfigItem(defaultValue="false")
public boolean keepAliveWithoutCalls

Whether keep-alive will be performed when there are no outstanding RPC on a connection.

maxHedgedAttempts

@ConfigItem(defaultValue="5")
public int maxHedgedAttempts

The max number of hedged attempts.

maxRetryAttempts

@ConfigItem(defaultValue="5")
public int maxRetryAttempts

The max number of retry attempts. Retry must be explicitly enabled.

maxTraceEvents

@ConfigItem
public OptionalInt maxTraceEvents

The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.

maxInboundMessageSize

@ConfigItem
public OptionalInt maxInboundMessageSize

The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB.

maxInboundMetadataSize

@ConfigItem
public OptionalInt maxInboundMetadataSize

The maximum size of metadata allowed to be received (in bytes). Default is 8192B.

negotiationType

@ConfigItem(defaultValue="TLS")
public String negotiationType

The negotiation type for the HTTP/2 connection. Accepted values are: TLS, PLAINTEXT_UPGRADE, PLAINTEXT

overrideAuthority

@ConfigItem
public Optional<String> overrideAuthority

Overrides the authority used with TLS and HTTP virtual hosting.

perRpcBufferLimit

@ConfigItem
public OptionalLong perRpcBufferLimit

The per RPC buffer limit in bytes used for retry.

retry

@ConfigItem(defaultValue="false")
public boolean retry

Whether retry is enabled. Note that retry is disabled by default.

retryBufferSize

@ConfigItem
public OptionalLong retryBufferSize

The retry buffer size in bytes.

userAgent

@ConfigItem
public Optional<String> userAgent

Use a custom user-agent.

loadBalancingPolicy

@ConfigItem(defaultValue="pick_first")
public String loadBalancingPolicy

Use a custom load balancing policy. Accepted values are: pick_value, round_robin, grpclb

compression

@ConfigItem
public Optional<String> compression

The compression to use for each call. The accepted values are gzip and identity.

deadline

@ConfigItem
public Optional<Duration> deadline

The deadline used for each call.

The format uses the standard Duration format. You can also provide duration values starting with a number. In this case, if the value consists only of a number, the converter treats the value as seconds. Otherwise, PT is implicitly prepended to the value to obtain a standard Duration format.

Constructor Detail

GrpcClientConfiguration

public GrpcClientConfiguration()