Packages

final class Plan extends GeneratedMessage with PlanOrBuilder

A [[Plan]] is the structure that carries the runtime information for the execution from the
client to the server. A [[Plan]] can be one of the following:
- [[Relation]]: a reference to the underlying logical plan.
- [[Command]]: used to execute commands on the server.
- [[CompressedOperation]]: a compressed representation of either a Relation or a Command.

Protobuf type spark.connect.Plan

Annotations
@Generated()
Linear Supertypes
PlanOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Plan
  2. PlanOrBuilder
  3. GeneratedMessage
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    Plan → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def getCommand(): Command

    .spark.connect.Command command = 2;

    .spark.connect.Command command = 2;

    returns

    The command.

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  12. def getCommandOrBuilder(): CommandOrBuilder

    .spark.connect.Command command = 2;

    .spark.connect.Command command = 2;

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  13. def getCompressedOperation(): CompressedOperation

    .spark.connect.Plan.CompressedOperation compressed_operation = 3;

    .spark.connect.Plan.CompressedOperation compressed_operation = 3;

    returns

    The compressedOperation.

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  14. def getCompressedOperationOrBuilder(): CompressedOperationOrBuilder

    .spark.connect.Plan.CompressedOperation compressed_operation = 3;

    .spark.connect.Plan.CompressedOperation compressed_operation = 3;

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  15. def getDefaultInstanceForType(): Plan
    Definition Classes
    Plan → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  16. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  17. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  20. def getOpTypeCase(): OpTypeCase
    Definition Classes
    Plan → PlanOrBuilder
  21. def getParserForType(): Parser[Plan]
    Definition Classes
    Plan → GeneratedMessage → Message → MessageLite
    Annotations
    @Override()
  22. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  23. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  24. def getRoot(): Relation

    .spark.connect.Relation root = 1;

    .spark.connect.Relation root = 1;

    returns

    The root.

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  25. def getRootOrBuilder(): RelationOrBuilder

    .spark.connect.Relation root = 1;

    .spark.connect.Relation root = 1;

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  26. def getSerializedSize(): Int
    Definition Classes
    Plan → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  27. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  28. def hasCommand(): Boolean

    .spark.connect.Command command = 2;

    .spark.connect.Command command = 2;

    returns

    Whether the command field is set.

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  29. def hasCompressedOperation(): Boolean

    .spark.connect.Plan.CompressedOperation compressed_operation = 3;

    .spark.connect.Plan.CompressedOperation compressed_operation = 3;

    returns

    Whether the compressedOperation field is set.

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  30. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  31. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  32. def hasRoot(): Boolean

    .spark.connect.Relation root = 1;

    .spark.connect.Relation root = 1;

    returns

    Whether the root field is set.

    Definition Classes
    Plan → PlanOrBuilder
    Annotations
    @Override()
  33. def hashCode(): Int
    Definition Classes
    Plan → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  34. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    Plan → GeneratedMessage
    Annotations
    @Override()
  35. def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  36. final def isInitialized(): Boolean
    Definition Classes
    Plan → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    Plan → AbstractMessage
    Annotations
    @Override()
  41. def newBuilderForType(): Builder
    Definition Classes
    Plan → Message → MessageLite
    Annotations
    @Override()
  42. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  45. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  46. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toBuilder(): Builder
    Definition Classes
    Plan → Message → MessageLite
    Annotations
    @Override()
  49. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  50. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  51. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  56. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  57. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Plan → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  58. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

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 internalGetMapField(fieldNumber: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @Deprecated
    Deprecated
  3. def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from PlanOrBuilder

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped