GrpcClientSettings

akka.grpc.GrpcClientSettings
See theGrpcClientSettings companion object
@ApiMayChange
final class GrpcClientSettings

Attributes

Companion:
object
Source:
GrpcClientSettings.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

@ApiMayChange
def withBackend(value: String): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
def withCallCredentials(value: CallCredentials): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
@ApiMayChange
def withChannelBuilderOverrides(builderOverrides: NettyChannelBuilder => NettyChannelBuilder): GrpcClientSettings

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.

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.

Attributes

Source:
GrpcClientSettings.scala

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.

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.

Attributes

Source:
GrpcClientSettings.scala
def withDeadline(value: Duration): GrpcClientSettings

Each call will have this deadline.

Each call will have this deadline.

Attributes

Source:
GrpcClientSettings.scala
def withDeadline(value: Duration): GrpcClientSettings

Each call will have this deadline.

Each call will have this deadline.

Attributes

Source:
GrpcClientSettings.scala

If using ServiceDiscovery and no port is returned use this one.

If using ServiceDiscovery and no port is returned use this one.

Attributes

Source:
GrpcClientSettings.scala
def withLoadBalancingPolicy(loadBalancingPolicy: String): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
def withResolveTimeout(value: FiniteDuration): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
def withServicePortName(servicePortName: String): GrpcClientSettings

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.

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.

Attributes

Source:
GrpcClientSettings.scala
def withServiceProtocol(serviceProtocol: String): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
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.

Prefer using withContextManager: withSslContext forces the ssl-provider 'jdk', which is known not to work on JDK 1.8.0_252.

Attributes

Source:
GrpcClientSettings.scala
def withSslProvider(sslProvider: SslProvider): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
def withTls(enabled: Boolean): GrpcClientSettings

Set to false to use unencrypted HTTP/2. This should not be used in production system.

Set to false to use unencrypted HTTP/2. This should not be used in production system.

Attributes

Source:
GrpcClientSettings.scala
def withTrustManager(trustManager: TrustManager): GrpcClientSettings

Attributes

Source:
GrpcClientSettings.scala
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.

Attributes

Source:
GrpcClientSettings.scala

Deprecated methods

def withGrpcLoadBalancingType(loadBalancingType: String): GrpcClientSettings

Attributes

Deprecated
[Since version 1.0.0]
Source:
GrpcClientSettings.scala

Concrete fields

val backend: String

Attributes

Source:
GrpcClientSettings.scala
val callCredentials: Option[CallCredentials]

Attributes

Source:
GrpcClientSettings.scala
val channelBuilderOverrides: NettyChannelBuilder => NettyChannelBuilder

Attributes

Source:
GrpcClientSettings.scala
val connectionAttempts: Option[Int]

Attributes

Source:
GrpcClientSettings.scala
val deadline: Duration

Attributes

Source:
GrpcClientSettings.scala
val defaultPort: Int

Attributes

Source:
GrpcClientSettings.scala
val loadBalancingPolicy: Option[String]

Attributes

Source:
GrpcClientSettings.scala
val overrideAuthority: Option[String]

Attributes

Source:
GrpcClientSettings.scala
val resolveTimeout: FiniteDuration

Attributes

Source:
GrpcClientSettings.scala
val serviceDiscovery: ServiceDiscovery

Attributes

Source:
GrpcClientSettings.scala
val serviceName: String

Attributes

Source:
GrpcClientSettings.scala
val servicePortName: Option[String]

Attributes

Source:
GrpcClientSettings.scala
val serviceProtocol: Option[String]

Attributes

Source:
GrpcClientSettings.scala
val sslContext: Option[SSLContext]

Attributes

Source:
GrpcClientSettings.scala
val sslProvider: Option[SslProvider]

Attributes

Source:
GrpcClientSettings.scala
val trustManager: Option[TrustManager]

Attributes

Source:
GrpcClientSettings.scala
val useTls: Boolean

Attributes

Source:
GrpcClientSettings.scala
val userAgent: Option[String]

Attributes

Source:
GrpcClientSettings.scala