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
- Alphabetic
- By Inheritance
- ExecutePlanResponse
- ExecutePlanResponseOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(obj: Any): Boolean
- Definition Classes
- ExecutePlanResponse → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
-
def
getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
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()
-
def
getArrowBatchOrBuilder(): ArrowBatchOrBuilder
.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDefaultInstanceForType(): ExecutePlanResponse
- Definition Classes
- ExecutePlanResponse → MessageOrBuilder → MessageLiteOrBuilder
- Annotations
- @Override()
-
def
getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
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()
-
def
getExtensionOrBuilder(): AnyOrBuilder
Support arbitrary result objects.
Support arbitrary result objects.
.google.protobuf.Any extension = 999;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getField(field: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getGetResourcesCommandResult(): GetResourcesCommandResult
Response for 'SparkContext.resources'.
Response for 'SparkContext.resources'.
.spark.connect.GetResourcesCommandResult get_resources_command_result = 10;- returns
The getResourcesCommandResult.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getGetResourcesCommandResultOrBuilder(): GetResourcesCommandResultOrBuilder
Response for 'SparkContext.resources'.
Response for 'SparkContext.resources'.
.spark.connect.GetResourcesCommandResult get_resources_command_result = 10;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
-
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()
-
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()
-
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()
-
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()
-
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()
-
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()
-
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()
-
def
getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
-
def
getOperationId(): String
Identifies the ExecutePlan execution. If set by the client in ExecutePlanRequest.operationId, that value is returned. Otherwise generated by the server. It is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
Identifies the ExecutePlan execution. If set by the client in ExecutePlanRequest.operationId, that value is returned. Otherwise generated by the server. It is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
string operation_id = 12;- returns
The operationId.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getOperationIdBytes(): ByteString
Identifies the ExecutePlan execution. If set by the client in ExecutePlanRequest.operationId, that value is returned. Otherwise generated by the server. It is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
Identifies the ExecutePlan execution. If set by the client in ExecutePlanRequest.operationId, that value is returned. Otherwise generated by the server. It is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
string operation_id = 12;- returns
The bytes for operationId.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getParserForType(): Parser[ExecutePlanResponse]
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3 → Message → MessageLite
- Annotations
- @Override()
-
def
getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getRepeatedFieldCount(field: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getResponseId(): String
Identified the response in the stream. The id is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
Identified the response in the stream. The id is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
string response_id = 13;- returns
The responseId.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getResponseIdBytes(): ByteString
Identified the response in the stream. The id is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
Identified the response in the stream. The id is an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`
string response_id = 13;- returns
The bytes for responseId.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getResponseTypeCase(): ResponseTypeCase
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
-
def
getResultComplete(): ResultComplete
Response type informing if the stream is complete in reattachable execution.
Response type informing if the stream is complete in reattachable execution.
.spark.connect.ExecutePlanResponse.ResultComplete result_complete = 14;- returns
The resultComplete.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getResultCompleteOrBuilder(): ResultCompleteOrBuilder
Response type informing if the stream is complete in reattachable execution.
Response type informing if the stream is complete in reattachable execution.
.spark.connect.ExecutePlanResponse.ResultComplete result_complete = 14;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
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()
-
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()
-
def
getSerializedSize(): Int
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
-
def
getSessionId(): String
string session_id = 1;string session_id = 1;- returns
The sessionId.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getSessionIdBytes(): ByteString
string session_id = 1;string session_id = 1;- returns
The bytes for sessionId.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
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()
-
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()
-
def
getStreamingQueryCommandResult(): StreamingQueryCommandResult
Response for commands on a streaming query.
Response for commands on a streaming query.
.spark.connect.StreamingQueryCommandResult streaming_query_command_result = 9;- returns
The streamingQueryCommandResult.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getStreamingQueryCommandResultOrBuilder(): StreamingQueryCommandResultOrBuilder
Response for commands on a streaming query.
Response for commands on a streaming query.
.spark.connect.StreamingQueryCommandResult streaming_query_command_result = 9;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getStreamingQueryManagerCommandResult(): StreamingQueryManagerCommandResult
Response for commands on the streaming query manager.
Response for commands on the streaming query manager.
.spark.connect.StreamingQueryManagerCommandResult streaming_query_manager_command_result = 11;- returns
The streamingQueryManagerCommandResult.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getStreamingQueryManagerCommandResultOrBuilder(): StreamingQueryManagerCommandResultOrBuilder
Response for commands on the streaming query manager.
Response for commands on the streaming query manager.
.spark.connect.StreamingQueryManagerCommandResult streaming_query_manager_command_result = 11;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getUnknownFields(): UnknownFieldSet
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getWriteStreamOperationStartResult(): WriteStreamOperationStartResult
Response for a streaming query.
Response for a streaming query.
.spark.connect.WriteStreamOperationStartResult write_stream_operation_start_result = 8;- returns
The writeStreamOperationStartResult.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
getWriteStreamOperationStartResultOrBuilder(): WriteStreamOperationStartResultOrBuilder
Response for a streaming query.
Response for a streaming query.
.spark.connect.WriteStreamOperationStartResult write_stream_operation_start_result = 8;- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
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()
-
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()
-
def
hasField(field: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
hasGetResourcesCommandResult(): Boolean
Response for 'SparkContext.resources'.
Response for 'SparkContext.resources'.
.spark.connect.GetResourcesCommandResult get_resources_command_result = 10;- returns
Whether the getResourcesCommandResult field is set.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
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()
-
def
hasOneof(oneof: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
-
def
hasResultComplete(): Boolean
Response type informing if the stream is complete in reattachable execution.
Response type informing if the stream is complete in reattachable execution.
.spark.connect.ExecutePlanResponse.ResultComplete result_complete = 14;- returns
Whether the resultComplete field is set.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
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()
-
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()
-
def
hasStreamingQueryCommandResult(): Boolean
Response for commands on a streaming query.
Response for commands on a streaming query.
.spark.connect.StreamingQueryCommandResult streaming_query_command_result = 9;- returns
Whether the streamingQueryCommandResult field is set.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
hasStreamingQueryManagerCommandResult(): Boolean
Response for commands on the streaming query manager.
Response for commands on the streaming query manager.
.spark.connect.StreamingQueryManagerCommandResult streaming_query_manager_command_result = 11;- returns
Whether the streamingQueryManagerCommandResult field is set.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
hasWriteStreamOperationStartResult(): Boolean
Response for a streaming query.
Response for a streaming query.
.spark.connect.WriteStreamOperationStartResult write_stream_operation_start_result = 8;- returns
Whether the writeStreamOperationStartResult field is set.
- Definition Classes
- ExecutePlanResponse → ExecutePlanResponseOrBuilder
- Annotations
- @Override()
-
def
hashCode(): Int
- Definition Classes
- ExecutePlanResponse → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
-
def
internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[proto]
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3
- Annotations
- @Override()
-
def
internalGetMapField(fieldNumber: Int): MapField[_, _]
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
-
final
def
isInitialized(): Boolean
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
- Annotations
- @Override()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[proto]
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3
- Annotations
- @Override()
-
def
newBuilderForType(): Builder
- Definition Classes
- ExecutePlanResponse → Message → MessageLite
- Annotations
- @Override()
-
def
newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
-
def
newInstance(unused: UnusedPrivateParameter): AnyRef
- Attributes
- protected[proto]
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3
- Annotations
- @Override() @SuppressWarnings()
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( classOf[java.io.IOException] )
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toBuilder(): Builder
- Definition Classes
- ExecutePlanResponse → Message → MessageLite
- Annotations
- @Override()
-
def
toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
-
def
toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
-
final
def
toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( ... )
-
def
writeTo(output: CodedOutputStream): Unit
- Definition Classes
- ExecutePlanResponse → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
-
def
writeTo(output: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws( classOf[java.io.IOException] )
Deprecated Value Members
-
def
mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( ... ) @Deprecated
- Deprecated