Packages

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val backend: String
  6. val callCredentials: Option[CallCredentials]
  7. val channelBuilderOverrides: (NettyChannelBuilder) => NettyChannelBuilder
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val connectingTimeout: Duration
  10. val connectionAttempts: Option[Int]
  11. val deadline: Duration
  12. val defaultPort: Int
  13. val discoveryRefreshInterval: Option[FiniteDuration]
  14. val eagerConnection: Boolean
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val loadBalancingPolicy: Option[String]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. val overrideAuthority: Option[String]
  25. val resolveTimeout: FiniteDuration
  26. val serviceDiscovery: ServiceDiscovery
  27. val serviceName: String
  28. val servicePortName: Option[String]
  29. val serviceProtocol: Option[String]
  30. val sslContext: Option[SSLContext]
  31. val sslContextProvider: Option[() => SSLContext]
  32. val sslProvider: Option[SslProvider]
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. val trustManager: Option[TrustManager]
  36. val useTls: Boolean
  37. val userAgent: Option[String]
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. def withBackend(value: String): GrpcClientSettings
    Annotations
    @ApiMayChange()
  42. def withCallCredentials(value: CallCredentials): GrpcClientSettings
  43. 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()
  44. def withConnectingTimeout(value: Duration): GrpcClientSettings

    If a connection attempt gets stuck in the CONNECTING state for longer than this duration, the client abandons that attempt and starts a new one rather than waiting on it forever.

    If a connection attempt gets stuck in the CONNECTING state for longer than this duration, the client abandons that attempt and starts a new one rather than waiting on it forever. Only supported for the Netty client backend.

  45. def withConnectingTimeout(value: Duration): GrpcClientSettings

    If a connection attempt gets stuck in the CONNECTING state for longer than this duration, the client abandons that attempt and starts a new one rather than waiting on it forever.

    If a connection attempt gets stuck in the CONNECTING state for longer than this duration, the client abandons that attempt and starts a new one rather than waiting on it forever. Only supported for the Netty client backend. Use Duration.Inf to disable.

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

  47. def withDeadline(value: Duration): GrpcClientSettings

    Each call will have this deadline.

  48. def withDeadline(value: Duration): GrpcClientSettings

    Each call will have this deadline.

  49. def withDefaultPort(value: Int): GrpcClientSettings

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

  50. def withDiscoveryRefreshInterval(refreshInterval: Duration): GrpcClientSettings

    Java API: Set this to a duration to trigger periodic refresh of the resolved endpoints, evicting cached entries if the discovery mechanism supports that.

    Java API: Set this to a duration to trigger periodic refresh of the resolved endpoints, evicting cached entries if the discovery mechanism supports that. The default is no periodic refresh and instead only does refresh when the client implementation decides to.

    Currently only supported by the Netty client backend.

    Annotations
    @ApiMayChange()
  51. def withDiscoveryRefreshInterval(refreshInterval: FiniteDuration): GrpcClientSettings

    Scala API: Set this to a duration to trigger periodic refresh of the resolved endpoints, evicting cached entries if the discovery mechanism supports that.

    Scala API: Set this to a duration to trigger periodic refresh of the resolved endpoints, evicting cached entries if the discovery mechanism supports that. The default is no periodic refresh and instead * only does refresh when the client implementation decides to.

    Currently only supported by the Netty client backend.

    Annotations
    @ApiMayChange()
  52. def withEagerConnection(eagerConnection: Boolean): GrpcClientSettings

    Request that the client try to connect the service immediately when the client is created rather than on the first request.

    Request that the client try to connect the service immediately when the client is created rather than on the first request. Only supported for the Netty client backend, the akka-http client backend is always eager.

  53. def withLoadBalancingPolicy(loadBalancingPolicy: String): GrpcClientSettings
  54. def withOverrideAuthority(value: String): GrpcClientSettings
  55. def withResolveTimeout(value: FiniteDuration): GrpcClientSettings
  56. 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.

  57. def withServiceProtocol(serviceProtocol: String): GrpcClientSettings
  58. def withSslContext(sslContext: SSLContext): GrpcClientSettings
  59. def withSslContextCreator(provider: Creator[SSLContext]): GrpcClientSettings

    Java API: For each new client connection, invoke this provider to set up TLS, useful for example for using rotating certs for the client provided by SSLContextFactory.refreshingSSLEngineProvider.

    Java API: For each new client connection, invoke this provider to set up TLS, useful for example for using rotating certs for the client provided by SSLContextFactory.refreshingSSLEngineProvider.

    When setting this the other TLS settings (sslContext,tlsManager) must not be set.

  60. def withSslContextProvider(provider: () => SSLContext): GrpcClientSettings

    Scala API: For each new client connection, invoke this provider to set up TLS, useful for example for using rotating certs for the client provided by SSLContextFactory.refreshingSSLEngineProvider.

    Scala API: For each new client connection, invoke this provider to set up TLS, useful for example for using rotating certs for the client provided by SSLContextFactory.refreshingSSLEngineProvider.

    When setting this the other TLS settings (sslContext,tlsManager) must not be set.

  61. def withSslProvider(sslProvider: SslProvider): GrpcClientSettings

    Note: Netty client backend specific setting

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

  63. def withTrustManager(trustManager: TrustManager): GrpcClientSettings
  64. 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 finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

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

    (Since version 1.0.0) use withLoadBalancingPolicy

Inherited from AnyRef

Inherited from Any

Ungrouped