Packages

c

org.apache.spark.connect.proto

ExecutePlanResponse

final class ExecutePlanResponse extends GeneratedMessageV3 with ExecutePlanResponseOrBuilder

The response of a query, can be one or more for each request. Responses belonging to the
same input query, carry the same `session_id`.

Protobuf type spark.connect.ExecutePlanResponse

Linear Supertypes
ExecutePlanResponseOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecutePlanResponse
  2. ExecutePlanResponseOrBuilder
  3. GeneratedMessageV3
  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]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    ExecutePlanResponse → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. def getArrowBatch(): ArrowBatch

    .spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;

    .spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;

    returns

    The arrowBatch.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  12. def getArrowBatchOrBuilder(): ArrowBatchOrBuilder

    .spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;

    .spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getDefaultInstanceForType(): ExecutePlanResponse
    Definition Classes
    ExecutePlanResponse → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  15. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getExtension(): Any

    Support arbitrary result objects.


    Support arbitrary result objects.

    .google.protobuf.Any extension = 999;

    returns

    The extension.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  17. def getExtensionOrBuilder(): AnyOrBuilder

    Support arbitrary result objects.


    Support arbitrary result objects.

    .google.protobuf.Any extension = 999;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  18. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  20. def getMetrics(): Metrics

    Metrics for the query execution. Typically, this field is only present in the last
batch of results and then represent the overall state of the query execution.


    Metrics for the query execution. Typically, this field is only present in the last
batch of results and then represent the overall state of the query execution.

    .spark.connect.ExecutePlanResponse.Metrics metrics = 4;

    returns

    The metrics.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  21. def getMetricsOrBuilder(): MetricsOrBuilder

    Metrics for the query execution. Typically, this field is only present in the last
batch of results and then represent the overall state of the query execution.


    Metrics for the query execution. Typically, this field is only present in the last
batch of results and then represent the overall state of the query execution.

    .spark.connect.ExecutePlanResponse.Metrics metrics = 4;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  22. def getObservedMetrics(index: Int): ObservedMetrics

    The metrics observed during the execution of the query plan.


    The metrics observed during the execution of the query plan.

    repeated .spark.connect.ExecutePlanResponse.ObservedMetrics observed_metrics = 6;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  23. def getObservedMetricsCount(): Int

    The metrics observed during the execution of the query plan.


    The metrics observed during the execution of the query plan.

    repeated .spark.connect.ExecutePlanResponse.ObservedMetrics observed_metrics = 6;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  24. def getObservedMetricsList(): List[ObservedMetrics]

    The metrics observed during the execution of the query plan.


    The metrics observed during the execution of the query plan.

    repeated .spark.connect.ExecutePlanResponse.ObservedMetrics observed_metrics = 6;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  25. def getObservedMetricsOrBuilder(index: Int): ObservedMetricsOrBuilder

    The metrics observed during the execution of the query plan.


    The metrics observed during the execution of the query plan.

    repeated .spark.connect.ExecutePlanResponse.ObservedMetrics observed_metrics = 6;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  26. def getObservedMetricsOrBuilderList(): List[_ <: ObservedMetricsOrBuilder]

    The metrics observed during the execution of the query plan.


    The metrics observed during the execution of the query plan.

    repeated .spark.connect.ExecutePlanResponse.ObservedMetrics observed_metrics = 6;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  27. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  28. def getParserForType(): Parser[ExecutePlanResponse]
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  29. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  31. def getResponseTypeCase(): ResponseTypeCase
    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
  32. def getSchema(): DataType

    (Optional) The Spark schema. This field is available when `collect` is called.


    (Optional) The Spark schema. This field is available when `collect` is called.

    .spark.connect.DataType schema = 7;

    returns

    The schema.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  33. def getSchemaOrBuilder(): DataTypeOrBuilder

    (Optional) The Spark schema. This field is available when `collect` is called.


    (Optional) The Spark schema. This field is available when `collect` is called.

    .spark.connect.DataType schema = 7;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  34. def getSerializedSize(): Int
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  35. def getSessionId(): String

    string session_id = 1;

    string session_id = 1;

    returns

    The sessionId.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  36. def getSessionIdBytes(): ByteString

    string session_id = 1;

    string session_id = 1;

    returns

    The bytes for sessionId.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  37. def getSqlCommandResult(): SqlCommandResult

    Special case for executing SQL commands.


    Special case for executing SQL commands.

    .spark.connect.ExecutePlanResponse.SqlCommandResult sql_command_result = 5;

    returns

    The sqlCommandResult.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  38. def getSqlCommandResultOrBuilder(): SqlCommandResultOrBuilder

    Special case for executing SQL commands.


    Special case for executing SQL commands.

    .spark.connect.ExecutePlanResponse.SqlCommandResult sql_command_result = 5;

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  39. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3 → MessageOrBuilder
    Annotations
    @Override()
  40. def hasArrowBatch(): Boolean

    .spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;

    .spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;

    returns

    Whether the arrowBatch field is set.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  41. def hasExtension(): Boolean

    Support arbitrary result objects.


    Support arbitrary result objects.

    .google.protobuf.Any extension = 999;

    returns

    Whether the extension field is set.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  42. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  43. def hasMetrics(): Boolean

    Metrics for the query execution. Typically, this field is only present in the last
batch of results and then represent the overall state of the query execution.


    Metrics for the query execution. Typically, this field is only present in the last
batch of results and then represent the overall state of the query execution.

    .spark.connect.ExecutePlanResponse.Metrics metrics = 4;

    returns

    Whether the metrics field is set.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  44. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  45. def hasSchema(): Boolean

    (Optional) The Spark schema. This field is available when `collect` is called.


    (Optional) The Spark schema. This field is available when `collect` is called.

    .spark.connect.DataType schema = 7;

    returns

    Whether the schema field is set.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  46. def hasSqlCommandResult(): Boolean

    Special case for executing SQL commands.


    Special case for executing SQL commands.

    .spark.connect.ExecutePlanResponse.SqlCommandResult sql_command_result = 5;

    returns

    Whether the sqlCommandResult field is set.

    Definition Classes
    ExecutePlanResponse → ExecutePlanResponseOrBuilder
    Annotations
    @Override()
  47. def hashCode(): Int
    Definition Classes
    ExecutePlanResponse → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  48. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3
    Annotations
    @Override()
  49. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  50. final def isInitialized(): Boolean
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3
    Annotations
    @Override()
  55. def newBuilderForType(): Builder
    Definition Classes
    ExecutePlanResponse → Message → MessageLite
    Annotations
    @Override()
  56. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  57. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[proto]
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  61. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def toBuilder(): Builder
    Definition Classes
    ExecutePlanResponse → Message → MessageLite
    Annotations
    @Override()
  64. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  65. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  66. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  70. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  71. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  72. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    ExecutePlanResponse → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  73. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from ExecutePlanResponseOrBuilder

Inherited from GeneratedMessageV3

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