final class GrpcClientSettings extends AnyRef
- Annotations
- @ApiMayChange()
- Source
- GrpcClientSettings.scala
- Alphabetic
- By Inheritance
- GrpcClientSettings
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
- val backend: String
- val callCredentials: Option[CallCredentials]
- val channelBuilderOverrides: (NettyChannelBuilder) ⇒ NettyChannelBuilder
- val connectionAttempts: Option[Int]
- val deadline: Duration
- val defaultPort: Int
- val loadBalancingPolicy: Option[String]
- val overrideAuthority: Option[String]
- val resolveTimeout: FiniteDuration
- val serviceDiscovery: ServiceDiscovery
- val serviceName: String
- val servicePortName: Option[String]
- val serviceProtocol: Option[String]
- val sslContext: Option[SSLContext]
- val sslProvider: Option[SslProvider]
- val trustManager: Option[TrustManager]
- val useTls: Boolean
- val userAgent: Option[String]
-
def
withBackend(value: String): GrpcClientSettings
- Annotations
- @ApiMayChange()
- def withCallCredentials(value: CallCredentials): GrpcClientSettings
-
def
withChannelBuilderOverrides(builderOverrides: (NettyChannelBuilder) ⇒ NettyChannelBuilder): GrpcClientSettings
To override any default channel configurations used by netty.
To override any default channel configurations used by netty. Only for power users. API may change when io.grpc:grpc-netty-shaded is replaced by io.grpc:grpc-core and Akka HTTP.
- Annotations
- @ApiMayChange()
-
def
withConnectionAttempts(value: Int): GrpcClientSettings
How many times to retry establishing a connection before failing the client Failure can be monitored using client.stopped and monitoring the Future/CompletionStage.
How many times to retry establishing a connection before failing the client Failure can be monitored using client.stopped and monitoring the Future/CompletionStage. An exponentially increasing backoff is used between attempts.
-
def
withDeadline(value: Duration): GrpcClientSettings
Each call will have this deadline.
-
def
withDeadline(value: Duration): GrpcClientSettings
Each call will have this deadline.
-
def
withDefaultPort(value: Int): GrpcClientSettings
If using ServiceDiscovery and no port is returned use this one.
- def withLoadBalancingPolicy(loadBalancingPolicy: String): GrpcClientSettings
- def withOverrideAuthority(value: String): GrpcClientSettings
- def withResolveTimeout(value: FiniteDuration): GrpcClientSettings
-
def
withServicePortName(servicePortName: String): GrpcClientSettings
When using service discovery, port name is the optional parameter to filter the requests.
When using service discovery, port name is the optional parameter to filter the requests. Looking up a service may return multiple ports (http/https/...) if the remote process only serves the grpc service on a specific port you must use this setting.
- def withServiceProtocol(serviceProtocol: String): GrpcClientSettings
-
def
withSslContext(sslContext: SSLContext): GrpcClientSettings
Prefer using
withContextManager
: withSslContext forces the ssl-provider 'jdk', which is known not to work on JDK 1.8.0_252. - def withSslProvider(sslProvider: SslProvider): GrpcClientSettings
-
def
withTls(enabled: Boolean): GrpcClientSettings
Set to false to use unencrypted HTTP/2.
Set to false to use unencrypted HTTP/2. This should not be used in production system.
- def withTrustManager(trustManager: TrustManager): GrpcClientSettings
-
def
withUserAgent(value: String): GrpcClientSettings
Provides a custom
User-Agent
for the application.Provides a custom
User-Agent
for the application.It's an optional parameter. The library will provide a user agent independent of this option. If provided, the given agent will prepend the library's user agent information.
Deprecated Value Members
-
def
withGrpcLoadBalancingType(loadBalancingType: String): GrpcClientSettings
- Annotations
- @deprecated
- Deprecated
(Since version 1.0.0) use withLoadBalancingPolicy