Packages

class Builder extends AnyRef

This is a helper class that is used to create a GRPC channel based on either a set host and port or a NameResolver-compliant URI connection string.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Builder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Builder()
  2. new Builder(_configuration: Configuration)

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. def build(): SparkConnectClient
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def configuration: Configuration
  8. def connectionString(connectionString: String): Builder

    Creates the channel with a target connection string, per the documentation of Spark Connect.

    Creates the channel with a target connection string, per the documentation of Spark Connect.

    Note: The connection string, if used, will override any previous host/port settings.

  9. def disableReattachableExecute(): Builder

    Disable reattachable execute.

  10. def disableSsl(): Builder

    Disables the SSL.

    Disables the SSL. Throws exception if the token has been set.

    returns

    this builder.

  11. def enableReattachableExecute(): Builder

    Enable reattachable execute.

    Enable reattachable execute.

    It makes client more robust, enabling reattaching to an ExecutePlanResponse stream in case of intermittent connection errors.

  12. def enableSsl(): Builder
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. def grpcMaxMessageSize: Int
  17. def grpcMaxMessageSize(messageSize: Int): Builder
  18. def grpcMaxRecursionLimit: Int
  19. def grpcMaxRecursionLimit(recursionLimit: Int): Builder
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. def host: String
  22. def host(inputHost: String): Builder
  23. def interceptor(interceptor: ClientInterceptor): Builder

    Add an interceptor to be used during channel creation.

    Add an interceptor to be used during channel creation.

    Note that interceptors added last are executed first by gRPC.

  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def loadFromEnvironment(): Builder

    Configure the builder using the env SPARK_REMOTE environment variable.

  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. def option(key: String, value: String): Builder
  30. def options: Map[String, String]
  31. def parse(args: Array[String]): Builder

    Configure the builder with the given CLI arguments.

  32. def port: Int
  33. def port(inputPort: Int): Builder
  34. def retryPolicy(policy: RetryPolicy): Builder
  35. def retryPolicy(policies: Seq[RetryPolicy]): Builder
  36. def sessionId: Option[String]
  37. def sessionId(value: String): Builder
  38. def sslEnabled: Boolean
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. def token: Option[String]
  42. def token(inputToken: String): Builder

    Setting the token implicitly sets the use_ssl=true.

    Setting the token implicitly sets the use_ssl=true. All the following examples yield the same results:

    sc://localhost/;token=aaa
sc://localhost/;use_ssl=true;token=aaa
sc://localhost/;token=aaa;use_ssl=true
    inputToken

    the user token.

    returns

    this builder.

  43. def userAgent: String
  44. def userAgent(value: String): Builder
  45. def userId: Option[String]
  46. def userId(id: String): Builder
  47. def userName: Option[String]
  48. def userName(name: String): Builder
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped