Packages

object functions

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. functions
  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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def from_protobuf(data: Column, options: Map[String, String]): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.

    Converts a binary column of Protobuf format into its corresponding catalyst value. The Protobuf schema is read from schema registry configured in options. The following options are supported and the first two options are required:

    • schema.registry.subject : [Required] Subject for the schema in the registry.
    • schema.registry.address : [Required] Schema registry address.
    • schema.registry.protobuf.name : [Optional] Specifies Protobuf name explicitly. This is useful when the schema in registry contains multiple protobufs. By default, the first Protobuf defined in the schema is selected. This option allows selecting any other Protobuf included in the the schema. E.g. consider a sample schema registered as below: 
               package com.example.protos;

         message Person {
           string name = 1;
           Location loc = 2;
         }
         message Location {
           string city = 1;
           int32 zipcode = 2;
         }
      If schema.registry.protobuf.name is not set, the first protobuf Person is used. If schema.registry.protobuf.name is set to "Location" (or its full name "com.example.protos.Location"), Location Protobuf is used. Similarly any imported Protobuf can also be specified.
    data

    the binary column.

    options

    Options including required configuration for schema registry as mentioned above.

    Annotations
    @Experimental()
    Since

    3.5.0 (DBR 14.2)

  9. def from_protobuf(data: Column, messageClassName: String, options: Map[String, String]): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.

    Converts a binary column of Protobuf format into its corresponding catalyst value. messageClassName points to Protobuf Java class. The jar containing Java class should be shaded. Specifically, com.google.protobuf.* should be shaded to org.sparkproject.spark_protobuf.protobuf.*. https://github.com/rangadi/shaded-protobuf-classes is useful to create shaded jar from Protobuf files.

    data

    the binary column.

    messageClassName

    The full name for Protobuf Java class. E.g. com.example.protos.ExampleEvent. The jar with these classes needs to be shaded as described above.

    Annotations
    @Experimental()
    Since

    3.5.0

  10. def from_protobuf(data: Column, messageName: String, binaryFileDescriptorSet: Array[Byte]): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    Converts a binary column of Protobuf format into its corresponding catalyst value.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    data

    the binary column.

    messageName

    the protobuf MessageName to look for in the descriptor set.

    binaryFileDescriptorSet

    Serialized Protobuf descriptor (FileDescriptorSet). Typically contents of file created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  11. def from_protobuf(data: Column, messageClassName: String): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.

    Converts a binary column of Protobuf format into its corresponding catalyst value. messageClassName points to Protobuf Java class. The jar containing Java class should be shaded. Specifically, com.google.protobuf.* should be shaded to org.sparkproject.spark_protobuf.protobuf.*. https://github.com/rangadi/shaded-protobuf-classes is useful to create shaded jar from Protobuf files.

    data

    the binary column.

    messageClassName

    The full name for Protobuf Java class. E.g. com.example.protos.ExampleEvent. The jar with these classes needs to be shaded as described above.

    Annotations
    @Experimental()
    Since

    3.5.0

  12. def from_protobuf(data: Column, messageName: String, descFilePath: String): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.

    Converts a binary column of Protobuf format into its corresponding catalyst value. The Protobuf definition is provided through Protobuf descriptor file.

    data

    the binary column.

    messageName

    the protobuf MessageName to look for in descriptor file.

    descFilePath

    The Protobuf descriptor file. This file is usually created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  13. def from_protobuf(data: Column, messageName: String, binaryFileDescriptorSet: Array[Byte], options: Map[String, String]): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    Converts a binary column of Protobuf format into its corresponding catalyst value.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    data

    the binary column.

    messageName

    the protobuf MessageName to look for in the descriptor set.

    binaryFileDescriptorSet

    Serialized Protobuf descriptor (FileDescriptorSet). Typically contents of file created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  14. def from_protobuf(data: Column, messageName: String, descFilePath: String, options: Map[String, String]): Column

    Converts a binary column of Protobuf format into its corresponding catalyst value.

    Converts a binary column of Protobuf format into its corresponding catalyst value. The Protobuf definition is provided through Protobuf descriptor file.

    data

    the binary column.

    messageName

    the protobuf message name to look for in descriptor file.

    descFilePath

    The Protobuf descriptor file. This file is usually created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def to_protobuf(data: Column, options: Map[String, String]): Column

    Converts a column into binary protobuf.

    Converts a column into binary protobuf. The schema for the column should match Protobuf schema. The Protobuf schema is read from schema registry configured in options. See documentation for from_protobuf() about description of schema registry options.

    data

    the binary column.

    options

    Options including required configuration for schema registry as described in documentation for from_protobuf().

    Annotations
    @Experimental()
    Since

    3.5.0 (DBR 14.2)

  24. def to_protobuf(data: Column, messageClassName: String, options: Map[String, String]): Column

    Converts a column into binary of protobuf format.

    Converts a column into binary of protobuf format. messageClassName points to Protobuf Java class. The jar containing Java class should be shaded. Specifically, com.google.protobuf.* should be shaded to org.sparkproject.spark_protobuf.protobuf.*. https://github.com/rangadi/shaded-protobuf-classes is useful to create shaded jar from Protobuf files.

    data

    the data column.

    messageClassName

    The full name for Protobuf Java class. E.g. com.example.protos.ExampleEvent. The jar with these classes needs to be shaded as described above.

    Annotations
    @Experimental()
    Since

    3.5.0

  25. def to_protobuf(data: Column, messageClassName: String): Column

    Converts a column into binary of protobuf format.

    Converts a column into binary of protobuf format. messageClassName points to Protobuf Java class. The jar containing Java class should be shaded. Specifically, com.google.protobuf.* should be shaded to org.sparkproject.spark_protobuf.protobuf.*. https://github.com/rangadi/shaded-protobuf-classes is useful to create shaded jar from Protobuf files.

    data

    the data column.

    messageClassName

    The full name for Protobuf Java class. E.g. com.example.protos.ExampleEvent. The jar with these classes needs to be shaded as described above.

    Annotations
    @Experimental()
    Since

    3.5.0

  26. def to_protobuf(data: Column, messageName: String, binaryFileDescriptorSet: Array[Byte], options: Map[String, String]): Column

    Converts a column into binary of protobuf format.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    Converts a column into binary of protobuf format.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    data

    the binary column.

    messageName

    the protobuf MessageName to look for in the descriptor set.

    binaryFileDescriptorSet

    Serialized Protobuf descriptor (FileDescriptorSet). Typically contents of file created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  27. def to_protobuf(data: Column, messageName: String, descFilePath: String, options: Map[String, String]): Column

    Converts a column into binary of protobuf format.

    Converts a column into binary of protobuf format. The Protobuf definition is provided through Protobuf descriptor file.

    data

    the data column.

    messageName

    the protobuf MessageName to look for in descriptor file.

    descFilePath

    The Protobuf descriptor file. This file is usually created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  28. def to_protobuf(data: Column, messageName: String, binaryFileDescriptorSet: Array[Byte]): Column

    Converts a column into binary of protobuf format.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    Converts a column into binary of protobuf format.The Protobuf definition is provided through Protobuf FileDescriptorSet.

    data

    the binary column.

    messageName

    the protobuf MessageName to look for in the descriptor set.

    binaryFileDescriptorSet

    Serialized Protobuf descriptor (FileDescriptorSet). Typically contents of file created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  29. def to_protobuf(data: Column, messageName: String, descFilePath: String): Column

    Converts a column into binary of protobuf format.

    Converts a column into binary of protobuf format. The Protobuf definition is provided through Protobuf descriptor file.

    data

    the data column.

    messageName

    the protobuf MessageName to look for in descriptor file.

    descFilePath

    The Protobuf descriptor file. This file is usually created using protoc with --descriptor_set_out and --include_imports options.

    Annotations
    @Experimental()
    Since

    3.5.0

  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped