final class GrpcClientSettings extends AnyRef

Annotations
@ApiMayChange()
Source
GrpcClientSettings.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrpcClientSettings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. val backend: String
  2. val callCredentials: Option[CallCredentials]
  3. val channelBuilderOverrides: (NettyChannelBuilder) ⇒ NettyChannelBuilder
  4. val connectionAttempts: Option[Int]
  5. val deadline: Duration
  6. val defaultPort: Int
  7. val loadBalancingPolicy: Option[String]
  8. val overrideAuthority: Option[String]
  9. val resolveTimeout: FiniteDuration
  10. val serviceDiscovery: ServiceDiscovery
  11. val serviceName: String
  12. val servicePortName: Option[String]
  13. val serviceProtocol: Option[String]
  14. val sslContext: Option[SSLContext]
  15. val sslProvider: Option[SslProvider]
  16. val trustManager: Option[TrustManager]
  17. val useTls: Boolean
  18. val userAgent: Option[String]
  19. def withBackend(value: String): GrpcClientSettings
    Annotations
    @ApiMayChange()
  20. def withCallCredentials(value: CallCredentials): GrpcClientSettings
  21. 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()
  22. 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.

  23. def withDeadline(value: Duration): GrpcClientSettings

    Each call will have this deadline.

  24. def withDeadline(value: Duration): GrpcClientSettings

    Each call will have this deadline.

  25. def withDefaultPort(value: Int): GrpcClientSettings

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

  26. def withLoadBalancingPolicy(loadBalancingPolicy: String): GrpcClientSettings
  27. def withOverrideAuthority(value: String): GrpcClientSettings
  28. def withResolveTimeout(value: FiniteDuration): GrpcClientSettings
  29. 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.

  30. def withServiceProtocol(serviceProtocol: String): GrpcClientSettings
  31. 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.

  32. def withSslProvider(sslProvider: SslProvider): GrpcClientSettings
  33. 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.

  34. def withTrustManager(trustManager: TrustManager): GrpcClientSettings
  35. 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

  1. def withGrpcLoadBalancingType(loadBalancingType: String): GrpcClientSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use withLoadBalancingPolicy