ExecutePlanResponseOrBuilder

trait ExecutePlanResponseOrBuilder extends MessageOrBuilder

Linear Supertypes

MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any

Known Subclasses

ExecutePlanResponse

Ordering

Alphabetic
By Inheritance

Inherited

ExecutePlanResponseOrBuilder
MessageOrBuilder
MessageLiteOrBuilder
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def findInitializationErrors(): List[String]
Definition Classes
MessageOrBuilder
abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
Definition Classes
MessageOrBuilder
abstract def getArrowBatch(): ArrowBatch
.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;
.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;
returns
The arrowBatch.
abstract def getArrowBatchOrBuilder(): ArrowBatchOrBuilder
.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;
abstract 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.
abstract def getCheckpointCommandResultOrBuilder(): CheckpointCommandResultOrBuilder
```
Response for command that checkpoints a DataFrame.
```
```
Response for command that checkpoints a DataFrame.
```
.spark.connect.CheckpointCommandResult checkpoint_command_result = 19;
abstract 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.
abstract def getCreateResourceProfileCommandResultOrBuilder(): CreateResourceProfileCommandResultOrBuilder
```
Response for command that creates ResourceProfile.
```
```
Response for command that creates ResourceProfile.
```
.spark.connect.CreateResourceProfileCommandResult create_resource_profile_command_result = 17;
abstract def getDefaultInstanceForType(): Message
Definition Classes
MessageOrBuilder → MessageLiteOrBuilder
abstract def getDescriptorForType(): Descriptor
Definition Classes
MessageOrBuilder
abstract def getExecutionProgress(): ExecutionProgress
```
(Optional) Intermediate query progress reports.
```
```
(Optional) Intermediate query progress reports.
```
.spark.connect.ExecutePlanResponse.ExecutionProgress execution_progress = 18;
returns
The executionProgress.
abstract def getExecutionProgressOrBuilder(): ExecutionProgressOrBuilder
```
(Optional) Intermediate query progress reports.
```
```
(Optional) Intermediate query progress reports.
```
.spark.connect.ExecutePlanResponse.ExecutionProgress execution_progress = 18;
abstract def getExtension(): Any
```
Support arbitrary result objects.
```
```
Support arbitrary result objects.
```
.google.protobuf.Any extension = 999;
returns
The extension.
abstract def getExtensionOrBuilder(): AnyOrBuilder
```
Support arbitrary result objects.
```
```
Support arbitrary result objects.
```
.google.protobuf.Any extension = 999;
abstract def getField(field: FieldDescriptor): AnyRef
Definition Classes
MessageOrBuilder
abstract def getGetResourcesCommandResult(): GetResourcesCommandResult
```
Response for 'SparkContext.resources'.
```
```
Response for 'SparkContext.resources'.
```
.spark.connect.GetResourcesCommandResult get_resources_command_result = 10;
returns
The getResourcesCommandResult.
abstract def getGetResourcesCommandResultOrBuilder(): GetResourcesCommandResultOrBuilder
```
Response for 'SparkContext.resources'.
```
```
Response for 'SparkContext.resources'.
```
.spark.connect.GetResourcesCommandResult get_resources_command_result = 10;
abstract def getInitializationErrorString(): String
Definition Classes
MessageOrBuilder

abstract 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.

abstract 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;

abstract def getMlCommandResult(): MlCommandResult
```
ML command response
```
```
ML command response
```
.spark.connect.MlCommandResult ml_command_result = 20;
returns
The mlCommandResult.
abstract def getMlCommandResultOrBuilder(): MlCommandResultOrBuilder
```
ML command response
```
```
ML command response
```
.spark.connect.MlCommandResult ml_command_result = 20;
abstract 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;

abstract 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;

abstract 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;
abstract 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;
abstract 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;
abstract def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
Definition Classes
MessageOrBuilder

abstract 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.

abstract 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.

abstract def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
Definition Classes
MessageOrBuilder
abstract def getRepeatedFieldCount(field: FieldDescriptor): Int
Definition Classes
MessageOrBuilder

abstract 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.

abstract 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.

abstract def getResponseTypeCase(): ResponseTypeCase

abstract 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.

abstract 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;

abstract 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.

abstract 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;

abstract 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.

abstract 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.

abstract def getSessionId(): String
string session_id = 1;
string session_id = 1;
returns
The sessionId.
abstract def getSessionIdBytes(): ByteString
string session_id = 1;
string session_id = 1;
returns
The bytes for sessionId.
abstract 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.
abstract def getSqlCommandResultOrBuilder(): SqlCommandResultOrBuilder
```
Special case for executing SQL commands.
```
```
Special case for executing SQL commands.
```
.spark.connect.ExecutePlanResponse.SqlCommandResult sql_command_result = 5;
abstract 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.
abstract 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;
abstract 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.
abstract 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;
abstract 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.
abstract 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;
abstract def getUnknownFields(): UnknownFieldSet
Definition Classes
MessageOrBuilder
abstract 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.
abstract def getWriteStreamOperationStartResultOrBuilder(): WriteStreamOperationStartResultOrBuilder
```
Response for a streaming query.
```
```
Response for a streaming query.
```
.spark.connect.WriteStreamOperationStartResult write_stream_operation_start_result = 8;
abstract def hasArrowBatch(): Boolean
.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;
.spark.connect.ExecutePlanResponse.ArrowBatch arrow_batch = 2;
returns
Whether the arrowBatch field is set.
abstract 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.
abstract 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.
abstract 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.
abstract def hasExtension(): Boolean
```
Support arbitrary result objects.
```
```
Support arbitrary result objects.
```
.google.protobuf.Any extension = 999;
returns
Whether the extension field is set.
abstract def hasField(field: FieldDescriptor): Boolean
Definition Classes
MessageOrBuilder
abstract 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.

abstract 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.

abstract def hasMlCommandResult(): Boolean
```
ML command response
```
```
ML command response
```
.spark.connect.MlCommandResult ml_command_result = 20;
returns
Whether the mlCommandResult field is set.
abstract def hasOneof(oneof: OneofDescriptor): Boolean
Definition Classes
MessageOrBuilder
abstract 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.

abstract 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.

abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract def isInitialized(): Boolean
Definition Classes
MessageLiteOrBuilder

Concrete 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(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
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])

Deprecated Value Members

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

Packages

ExecutePlanResponseOrBuilder

trait ExecutePlanResponseOrBuilder extends MessageOrBuilder

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

ExecutePlanResponseOrBuilder

trait ExecutePlanResponseOrBuilder extends MessageOrBuilder

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped

ExecutePlanResponseOrBuilder