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. def allowArrowBatchChunking: Boolean
  5. def allowArrowBatchChunking(allow: Boolean): Builder
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def build(): SparkConnectClient
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. def configuration: Configuration
  10. 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.

  11. def disableReattachableExecute(): Builder

    Disable reattachable execute.

  12. def disableSsl(): Builder

    Disables the SSL.

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

    returns

    this builder.

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

  14. def enableSsl(): Builder
  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
    @IntrinsicCandidate() @native()
  18. def grpcMaxMessageSize: Int
  19. def grpcMaxMessageSize(messageSize: Int): Builder
  20. def grpcMaxRecursionLimit: Int
  21. def grpcMaxRecursionLimit(recursionLimit: Int): Builder
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. def host: String
  24. def host(inputHost: String): Builder
  25. 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.

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

    Configure the builder using the env SPARK_REMOTE environment variable.

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

    Configure the builder with the given CLI arguments.

  34. def port: Int
  35. def port(inputPort: Int): Builder
  36. def preferredArrowChunkSize: Option[Int]
  37. def preferredArrowChunkSize(size: Option[Int]): Builder
  38. def retryPolicy(policy: RetryPolicy): Builder
  39. def retryPolicy(policies: Seq[RetryPolicy]): Builder
  40. def sessionId: Option[String]
  41. def sessionId(value: String): Builder
  42. def sslEnabled: Boolean
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. def token: Option[String]
  46. 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.

  47. def userAgent: String
  48. def userAgent(value: String): Builder
  49. def userId: Option[String]
  50. def userId(id: String): Builder
  51. def userName: Option[String]
  52. def userName(name: String): Builder
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. 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