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

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( ... ) @native()
  9. val connectionAttempts: Option[Int]
  10. val deadline: Duration
  11. val defaultPort: Int
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val loadBalancingPolicy: Option[String]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val overrideAuthority: Option[String]
  23. val resolveTimeout: FiniteDuration
  24. val serviceDiscovery: ServiceDiscovery
  25. val serviceName: String
  26. val servicePortName: Option[String]
  27. val serviceProtocol: Option[String]
  28. val sslContext: Option[SSLContext]
  29. val sslProvider: Option[SslProvider]
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. val trustManager: Option[TrustManager]
  33. val useTls: Boolean
  34. val userAgent: Option[String]
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. def withBackend(value: String): GrpcClientSettings
    Annotations
    @ApiMayChange()
  39. def withCallCredentials(value: CallCredentials): GrpcClientSettings
  40. 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 Pekko HTTP.

    Annotations
    @ApiMayChange()
  41. 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.

  42. def withDeadline(value: Duration): GrpcClientSettings

    Each call will have this deadline.

  43. def withDeadline(value: Duration): GrpcClientSettings

    Each call will have this deadline.

  44. def withDefaultPort(value: Int): GrpcClientSettings

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

  45. def withLoadBalancingPolicy(loadBalancingPolicy: String): GrpcClientSettings
  46. def withOverrideAuthority(value: String): GrpcClientSettings
  47. def withResolveTimeout(value: FiniteDuration): GrpcClientSettings
  48. 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.

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

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

  53. def withTrustManager(trustManager: TrustManager): GrpcClientSettings
  54. 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 akka-grpc 1.0.0) use withLoadBalancingPolicy

Inherited from AnyRef

Inherited from Any

Ungrouped