ExecutePlanResponse

final class ExecutePlanResponse extends GeneratedMessage 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`.
Next ID: 17

Protobuf type spark.connect.ExecutePlanResponse

Annotations: @Generated()

Linear Supertypes

ExecutePlanResponseOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ExecutePlanResponse
ExecutePlanResponseOrBuilder
GeneratedMessage
Serializable
AbstractMessage
Message
MessageOrBuilder
AbstractMessageLite
MessageLite
MessageLiteOrBuilder
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(obj: AnyRef): Boolean
Definition Classes
ExecutePlanResponse → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def findInitializationErrors(): List[String]
Definition Classes
AbstractMessage → MessageOrBuilder
def getAllFields(): Map[FieldDescriptor, AnyRef]
Definition Classes
GeneratedMessage → 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()
def getCheckpointCommandResult(): CheckpointCommandResult
```
Response for command that checkpoints a DataFrame.
```
```
Response for command that checkpoints a DataFrame.
```
.spark.connect.CheckpointCommandResult checkpoint_command_result = 19;
returns
The checkpointCommandResult.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getCheckpointCommandResultOrBuilder(): CheckpointCommandResultOrBuilder
```
Response for command that checkpoints a DataFrame.
```
```
Response for command that checkpoints a DataFrame.
```
.spark.connect.CheckpointCommandResult checkpoint_command_result = 19;
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def getCreateResourceProfileCommandResult(): CreateResourceProfileCommandResult
```
Response for command that creates ResourceProfile.
```
```
Response for command that creates ResourceProfile.
```
.spark.connect.CreateResourceProfileCommandResult create_resource_profile_command_result = 17;
returns
The createResourceProfileCommandResult.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getCreateResourceProfileCommandResultOrBuilder(): CreateResourceProfileCommandResultOrBuilder
```
Response for command that creates ResourceProfile.
```
```
Response for command that creates ResourceProfile.
```
.spark.connect.CreateResourceProfileCommandResult create_resource_profile_command_result = 17;
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getDefaultInstanceForType(): ExecutePlanResponse
Definition Classes
ExecutePlanResponse → MessageOrBuilder → MessageLiteOrBuilder
Annotations
@Override()
def getDescriptorForType(): Descriptor
Definition Classes
GeneratedMessage → MessageOrBuilder
def getExecutionProgress(): ExecutionProgress
```
(Optional) Intermediate query progress reports.
```
```
(Optional) Intermediate query progress reports.
```
.spark.connect.ExecutePlanResponse.ExecutionProgress execution_progress = 18;
returns
The executionProgress.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getExecutionProgressOrBuilder(): ExecutionProgressOrBuilder
```
(Optional) Intermediate query progress reports.
```
```
(Optional) Intermediate query progress reports.
```
.spark.connect.ExecutePlanResponse.ExecutionProgress execution_progress = 18;
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
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
GeneratedMessage → 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 getMlCommandResult(): MlCommandResult
```
ML command response
```
```
ML command response
```
.spark.connect.MlCommandResult ml_command_result = 20;
returns
The mlCommandResult.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getMlCommandResultOrBuilder(): MlCommandResultOrBuilder
```
ML command response
```
```
ML command response
```
.spark.connect.MlCommandResult ml_command_result = 20;
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
GeneratedMessage → 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 → GeneratedMessage → Message → MessageLite
Annotations
@Override()
def getPipelineCommandResult(): PipelineCommandResult
```
Pipeline command response
```
```
Pipeline command response
```
.spark.connect.PipelineCommandResult pipeline_command_result = 22;
returns
The pipelineCommandResult.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getPipelineCommandResultOrBuilder(): PipelineCommandResultOrBuilder
```
Pipeline command response
```
```
Pipeline command response
```
.spark.connect.PipelineCommandResult pipeline_command_result = 22;
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getPipelineEventResult(): PipelineEventResult
```
Response containing pipeline event that is streamed back to the client during a pipeline run
```
```
Response containing pipeline event that is streamed back to the client during a pipeline run
```
.spark.connect.PipelineEventResult pipeline_event_result = 21;
returns
The pipelineEventResult.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getPipelineEventResultOrBuilder(): PipelineEventResultOrBuilder
```
Response containing pipeline event that is streamed back to the client during a pipeline run
```
```
Response containing pipeline event that is streamed back to the client during a pipeline run
```
.spark.connect.PipelineEventResult pipeline_event_result = 21;
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getPipelineQueryFunctionExecutionSignal(): PipelineQueryFunctionExecutionSignal
```
A signal from the server to the client to execute the query function for a flow, and to
register its result with the server.
```
```
A signal from the server to the client to execute the query function for a flow, and to
register its result with the server.
```
.spark.connect.PipelineQueryFunctionExecutionSignal pipeline_query_function_execution_signal = 23;
returns
The pipelineQueryFunctionExecutionSignal.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getPipelineQueryFunctionExecutionSignalOrBuilder(): PipelineQueryFunctionExecutionSignalOrBuilder
```
A signal from the server to the client to execute the query function for a flow, and to
register its result with the server.
```
```
A signal from the server to the client to execute the query function for a flow, and to
register its result with the server.
```
.spark.connect.PipelineQueryFunctionExecutionSignal pipeline_query_function_execution_signal = 23;
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
Definition Classes
GeneratedMessage → MessageOrBuilder
def getRepeatedFieldCount(field: FieldDescriptor): Int
Definition Classes
GeneratedMessage → 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 → GeneratedMessage → AbstractMessage → MessageLite
Annotations
@Override()

def getServerSideSessionId(): String

Server-side generated idempotency key that the client can use to assert that the server side
session has not changed.

Server-side generated idempotency key that the client can use to assert that the server side
session has not changed.

string server_side_session_id = 15;

returns: The serverSideSessionId.

Definition Classes: ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations: @Override()

def getServerSideSessionIdBytes(): ByteString

Server-side generated idempotency key that the client can use to assert that the server side
session has not changed.

Server-side generated idempotency key that the client can use to assert that the server side
session has not changed.

string server_side_session_id = 15;

returns: The bytes for serverSideSessionId.

Definition Classes: ExecutePlanResponse → ExecutePlanResponseOrBuilder
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 getStreamingQueryListenerEventsResult(): StreamingQueryListenerEventsResult
```
Response for commands on the client side streaming query listener.
```
```
Response for commands on the client side streaming query listener.
```
.spark.connect.StreamingQueryListenerEventsResult streaming_query_listener_events_result = 16;
returns
The streamingQueryListenerEventsResult.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def getStreamingQueryListenerEventsResultOrBuilder(): StreamingQueryListenerEventsResultOrBuilder
```
Response for commands on the client side streaming query listener.
```
```
Response for commands on the client side streaming query listener.
```
.spark.connect.StreamingQueryListenerEventsResult streaming_query_listener_events_result = 16;
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
GeneratedMessage → 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 hasCheckpointCommandResult(): Boolean
```
Response for command that checkpoints a DataFrame.
```
```
Response for command that checkpoints a DataFrame.
```
.spark.connect.CheckpointCommandResult checkpoint_command_result = 19;
returns
Whether the checkpointCommandResult field is set.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def hasCreateResourceProfileCommandResult(): Boolean
```
Response for command that creates ResourceProfile.
```
```
Response for command that creates ResourceProfile.
```
.spark.connect.CreateResourceProfileCommandResult create_resource_profile_command_result = 17;
returns
Whether the createResourceProfileCommandResult field is set.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def hasExecutionProgress(): Boolean
```
(Optional) Intermediate query progress reports.
```
```
(Optional) Intermediate query progress reports.
```
.spark.connect.ExecutePlanResponse.ExecutionProgress execution_progress = 18;
returns
Whether the executionProgress 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
GeneratedMessage → 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 hasMlCommandResult(): Boolean
```
ML command response
```
```
ML command response
```
.spark.connect.MlCommandResult ml_command_result = 20;
returns
Whether the mlCommandResult field is set.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def hasOneof(oneof: OneofDescriptor): Boolean
Definition Classes
GeneratedMessage → AbstractMessage → MessageOrBuilder
def hasPipelineCommandResult(): Boolean
```
Pipeline command response
```
```
Pipeline command response
```
.spark.connect.PipelineCommandResult pipeline_command_result = 22;
returns
Whether the pipelineCommandResult field is set.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def hasPipelineEventResult(): Boolean
```
Response containing pipeline event that is streamed back to the client during a pipeline run
```
```
Response containing pipeline event that is streamed back to the client during a pipeline run
```
.spark.connect.PipelineEventResult pipeline_event_result = 21;
returns
Whether the pipelineEventResult field is set.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
def hasPipelineQueryFunctionExecutionSignal(): Boolean
```
A signal from the server to the client to execute the query function for a flow, and to
register its result with the server.
```
```
A signal from the server to the client to execute the query function for a flow, and to
register its result with the server.
```
.spark.connect.PipelineQueryFunctionExecutionSignal pipeline_query_function_execution_signal = 23;
returns
Whether the pipelineQueryFunctionExecutionSignal field is set.
Definition Classes
ExecutePlanResponse → ExecutePlanResponseOrBuilder
Annotations
@Override()
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 hasStreamingQueryListenerEventsResult(): Boolean
```
Response for commands on the client side streaming query listener.
```
```
Response for commands on the client side streaming query listener.
```
.spark.connect.StreamingQueryListenerEventsResult streaming_query_listener_events_result = 16;
returns
Whether the streamingQueryListenerEventsResult 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 → GeneratedMessage
Annotations
@Override()
def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
final def isInitialized(): Boolean
Definition Classes
ExecutePlanResponse → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
Annotations
@Override()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def makeExtensionsImmutable(): Unit
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def newBuilderForType(parent: BuilderParent): Builder
Attributes
protected[proto]
Definition Classes
ExecutePlanResponse → AbstractMessage
Annotations
@Override()
def newBuilderForType(): Builder
Definition Classes
ExecutePlanResponse → Message → MessageLite
Annotations
@Override()
def newInstance(unused: UnusedPrivateParameter): AnyRef
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@throws(classOf[java.io.IOException])
def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
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(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def writeDelimitedTo(output: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])
def writeReplace(): AnyRef
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@throws(classOf[java.io.ObjectStreamException])
def writeTo(output: CodedOutputStream): Unit
Definition Classes
ExecutePlanResponse → GeneratedMessage → AbstractMessage → MessageLite
Annotations
@Override()
def writeTo(output: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def internalGetMapField(fieldNumber: Int): MapField[_ <: AnyRef, _ <: AnyRef]
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@Deprecated
Deprecated
def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
Deprecated

Packages

ExecutePlanResponse

final class ExecutePlanResponse extends GeneratedMessage with ExecutePlanResponseOrBuilder

Value Members

Deprecated Value Members

Inherited from ExecutePlanResponseOrBuilder

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

Packages

ExecutePlanResponse

final class ExecutePlanResponse extends GeneratedMessage with ExecutePlanResponseOrBuilder

Value Members

Deprecated Value Members

Inherited from ExecutePlanResponseOrBuilder

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

ExecutePlanResponse