proto

package proto

Type Members

final class AddArtifactsRequest extends GeneratedMessage with AddArtifactsRequestOrBuilder
```
Request to transfer client-local artifacts.
```
```
Request to transfer client-local artifacts.
```
Protobuf type spark.connect.AddArtifactsRequest
Annotations
@Generated()
trait AddArtifactsRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class AddArtifactsResponse extends GeneratedMessage with AddArtifactsResponseOrBuilder

Response to adding an artifact. Contains relevant metadata to verify successful transfer of
artifact(s).
Next ID: 4

Response to adding an artifact. Contains relevant metadata to verify successful transfer of
artifact(s).
Next ID: 4

Protobuf type spark.connect.AddArtifactsResponse

Annotations: @Generated()

trait AddArtifactsResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Aggregate extends GeneratedMessage with AggregateOrBuilder
```
Relation of type [[Aggregate]].
```
```
Relation of type [[Aggregate]].
```
Protobuf type spark.connect.Aggregate
Annotations
@Generated()
trait AggregateOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class AnalyzePlanRequest extends GeneratedMessage with AnalyzePlanRequestOrBuilder
```
Request to perform plan analyze, optionally to explain the plan.
```
```
Request to perform plan analyze, optionally to explain the plan.
```
Protobuf type spark.connect.AnalyzePlanRequest
Annotations
@Generated()
trait AnalyzePlanRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class AnalyzePlanResponse extends GeneratedMessage with AnalyzePlanResponseOrBuilder

Response to performing analysis of the query. Contains relevant metadata to be able to
reason about the performance.
Next ID: 16

Response to performing analysis of the query. Contains relevant metadata to be able to
reason about the performance.
Next ID: 16

Protobuf type spark.connect.AnalyzePlanResponse

Annotations: @Generated()

trait AnalyzePlanResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ApplyInPandasWithState extends GeneratedMessage with ApplyInPandasWithStateOrBuilder
Protobuf type spark.connect.ApplyInPandasWithState
Protobuf type spark.connect.ApplyInPandasWithState
Annotations
@Generated()
trait ApplyInPandasWithStateOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ArtifactStatusesRequest extends GeneratedMessage with ArtifactStatusesRequestOrBuilder
```
Request to get current statuses of artifacts at the server side.
```
```
Request to get current statuses of artifacts at the server side.
```
Protobuf type spark.connect.ArtifactStatusesRequest
Annotations
@Generated()
trait ArtifactStatusesRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ArtifactStatusesResponse extends GeneratedMessage with ArtifactStatusesResponseOrBuilder
```
Response to checking artifact statuses.
Next ID: 4
```
```
Response to checking artifact statuses.
Next ID: 4
```
Protobuf type spark.connect.ArtifactStatusesResponse
Annotations
@Generated()
trait ArtifactStatusesResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class AsOfJoin extends GeneratedMessage with AsOfJoinOrBuilder

Relation of type [[AsOfJoin]].

`left` and `right` must be present.

Relation of type [[AsOfJoin]].

`left` and `right` must be present.

Protobuf type spark.connect.AsOfJoin

Annotations: @Generated()

trait AsOfJoinOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Base extends GeneratedFile
Annotations
@Generated()
final class Bools extends GeneratedMessage with BoolsOrBuilder
Protobuf type spark.connect.Bools
Protobuf type spark.connect.Bools
Annotations
@Generated()
trait BoolsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CacheTable extends GeneratedMessage with CacheTableOrBuilder
```
See `spark.catalog.cacheTable`
```
```
See `spark.catalog.cacheTable`
```
Protobuf type spark.connect.CacheTable
Annotations
@Generated()
trait CacheTableOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class CachedLocalRelation extends GeneratedMessage with CachedLocalRelationOrBuilder

A local relation that has been cached already.
CachedLocalRelation doesn't support LocalRelations of size over 2GB.

A local relation that has been cached already.
CachedLocalRelation doesn't support LocalRelations of size over 2GB.

Protobuf type spark.connect.CachedLocalRelation

Annotations: @Generated()

trait CachedLocalRelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CachedRemoteRelation extends GeneratedMessage with CachedRemoteRelationOrBuilder
```
Represents a remote relation that has been cached on server.
```
```
Represents a remote relation that has been cached on server.
```
Protobuf type spark.connect.CachedRemoteRelation
Annotations
@Generated()
trait CachedRemoteRelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CallFunction extends GeneratedMessage with CallFunctionOrBuilder
Protobuf type spark.connect.CallFunction
Protobuf type spark.connect.CallFunction
Annotations
@Generated()
trait CallFunctionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Catalog extends GeneratedMessage with CatalogOrBuilder
```
Catalog messages are marked as unstable.
```
```
Catalog messages are marked as unstable.
```
Protobuf type spark.connect.Catalog
Annotations
@Generated()
trait CatalogOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CatalogOuterClass extends GeneratedFile
Annotations
@Generated()
final class CheckpointCommand extends GeneratedMessage with CheckpointCommandOrBuilder
Protobuf type spark.connect.CheckpointCommand
Protobuf type spark.connect.CheckpointCommand
Annotations
@Generated()
trait CheckpointCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CheckpointCommandResult extends GeneratedMessage with CheckpointCommandResultOrBuilder
Protobuf type spark.connect.CheckpointCommandResult
Protobuf type spark.connect.CheckpointCommandResult
Annotations
@Generated()
trait CheckpointCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ChunkedCachedLocalRelation extends GeneratedMessage with ChunkedCachedLocalRelationOrBuilder
```
A local relation that has been cached already.
```
```
A local relation that has been cached already.
```
Protobuf type spark.connect.ChunkedCachedLocalRelation
Annotations
@Generated()
trait ChunkedCachedLocalRelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ClearCache extends GeneratedMessage with ClearCacheOrBuilder
```
See `spark.catalog.clearCache`
```
```
See `spark.catalog.clearCache`
```
Protobuf type spark.connect.ClearCache
Annotations
@Generated()
trait ClearCacheOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CloneSessionRequest extends GeneratedMessage with CloneSessionRequestOrBuilder
Protobuf type spark.connect.CloneSessionRequest
Protobuf type spark.connect.CloneSessionRequest
Annotations
@Generated()
trait CloneSessionRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CloneSessionResponse extends GeneratedMessage with CloneSessionResponseOrBuilder
```
Next ID: 5
```
```
Next ID: 5
```
Protobuf type spark.connect.CloneSessionResponse
Annotations
@Generated()
trait CloneSessionResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CoGroupMap extends GeneratedMessage with CoGroupMapOrBuilder
Protobuf type spark.connect.CoGroupMap
Protobuf type spark.connect.CoGroupMap
Annotations
@Generated()
trait CoGroupMapOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CollectMetrics extends GeneratedMessage with CollectMetricsOrBuilder
```
Collect arbitrary (named) metrics from a dataset.
```
```
Collect arbitrary (named) metrics from a dataset.
```
Protobuf type spark.connect.CollectMetrics
Annotations
@Generated()
trait CollectMetricsOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Command extends GeneratedMessage with CommandOrBuilder

A [[Command]] is an operation that is executed by the server that does not directly consume or
produce a relational result.

A [[Command]] is an operation that is executed by the server that does not directly consume or
produce a relational result.

Protobuf type spark.connect.Command

Annotations: @Generated()

trait CommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Commands extends GeneratedFile
Annotations
@Generated()
final class Common extends GeneratedFile
Annotations
@Generated()
final class CommonInlineUserDefinedDataSource extends GeneratedMessage with CommonInlineUserDefinedDataSourceOrBuilder
Protobuf type spark.connect.CommonInlineUserDefinedDataSource
Protobuf type spark.connect.CommonInlineUserDefinedDataSource
Annotations
@Generated()
trait CommonInlineUserDefinedDataSourceOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CommonInlineUserDefinedFunction extends GeneratedMessage with CommonInlineUserDefinedFunctionOrBuilder
Protobuf type spark.connect.CommonInlineUserDefinedFunction
Protobuf type spark.connect.CommonInlineUserDefinedFunction
Annotations
@Generated()
trait CommonInlineUserDefinedFunctionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CommonInlineUserDefinedTableFunction extends GeneratedMessage with CommonInlineUserDefinedTableFunctionOrBuilder
Protobuf type spark.connect.CommonInlineUserDefinedTableFunction
Protobuf type spark.connect.CommonInlineUserDefinedTableFunction
Annotations
@Generated()
trait CommonInlineUserDefinedTableFunctionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
sealed final class CompressionCodec extends Enum[CompressionCodec] with ProtocolMessageEnum
```
Compression codec for plan compression.
```
```
Compression codec for plan compression.
```
Protobuf enum spark.connect.CompressionCodec
Annotations
@Generated()
final class ConfigRequest extends GeneratedMessage with ConfigRequestOrBuilder
```
Request to update or fetch the configurations.
```
```
Request to update or fetch the configurations.
```
Protobuf type spark.connect.ConfigRequest
Annotations
@Generated()
trait ConfigRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ConfigResponse extends GeneratedMessage with ConfigResponseOrBuilder
```
Response to the config request.
Next ID: 5
```
```
Response to the config request.
Next ID: 5
```
Protobuf type spark.connect.ConfigResponse
Annotations
@Generated()
trait ConfigResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CreateDataFrameViewCommand extends GeneratedMessage with CreateDataFrameViewCommandOrBuilder
```
A command that can create DataFrame global temp view or local temp view.
```
```
A command that can create DataFrame global temp view or local temp view.
```
Protobuf type spark.connect.CreateDataFrameViewCommand
Annotations
@Generated()
trait CreateDataFrameViewCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CreateExternalTable extends GeneratedMessage with CreateExternalTableOrBuilder
```
See `spark.catalog.createExternalTable`
```
```
See `spark.catalog.createExternalTable`
```
Protobuf type spark.connect.CreateExternalTable
Annotations
@Generated()
trait CreateExternalTableOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CreateResourceProfileCommand extends GeneratedMessage with CreateResourceProfileCommandOrBuilder
```
Command to create ResourceProfile
```
```
Command to create ResourceProfile
```
Protobuf type spark.connect.CreateResourceProfileCommand
Annotations
@Generated()
trait CreateResourceProfileCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CreateResourceProfileCommandResult extends GeneratedMessage with CreateResourceProfileCommandResultOrBuilder
```
Response for command 'CreateResourceProfileCommand'.
```
```
Response for command 'CreateResourceProfileCommand'.
```
Protobuf type spark.connect.CreateResourceProfileCommandResult
Annotations
@Generated()
trait CreateResourceProfileCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CreateTable extends GeneratedMessage with CreateTableOrBuilder
```
See `spark.catalog.createTable`
```
```
See `spark.catalog.createTable`
```
Protobuf type spark.connect.CreateTable
Annotations
@Generated()
trait CreateTableOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CurrentCatalog extends GeneratedMessage with CurrentCatalogOrBuilder
```
See `spark.catalog.currentCatalog`
```
```
See `spark.catalog.currentCatalog`
```
Protobuf type spark.connect.CurrentCatalog
Annotations
@Generated()
trait CurrentCatalogOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class CurrentDatabase extends GeneratedMessage with CurrentDatabaseOrBuilder
```
See `spark.catalog.currentDatabase`
```
```
See `spark.catalog.currentDatabase`
```
Protobuf type spark.connect.CurrentDatabase
Annotations
@Generated()
trait CurrentDatabaseOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class DataType extends GeneratedMessage with DataTypeOrBuilder

This message describes the logical [[DataType]] of something. It does not carry the value
itself but only describes it.

This message describes the logical [[DataType]] of something. It does not carry the value
itself but only describes it.

Protobuf type spark.connect.DataType

Annotations: @Generated()

trait DataTypeOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class DatabaseExists extends GeneratedMessage with DatabaseExistsOrBuilder
```
See `spark.catalog.databaseExists`
```
```
See `spark.catalog.databaseExists`
```
Protobuf type spark.connect.DatabaseExists
Annotations
@Generated()
trait DatabaseExistsOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Deduplicate extends GeneratedMessage with DeduplicateOrBuilder

Relation of type [[Deduplicate]] which have duplicate rows removed, could consider either only
the subset of columns or all the columns.

Relation of type [[Deduplicate]] which have duplicate rows removed, could consider either only
the subset of columns or all the columns.

Protobuf type spark.connect.Deduplicate

Annotations: @Generated()

trait DeduplicateOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Doubles extends GeneratedMessage with DoublesOrBuilder
Protobuf type spark.connect.Doubles
Protobuf type spark.connect.Doubles
Annotations
@Generated()
trait DoublesOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Drop extends GeneratedMessage with DropOrBuilder
```
Drop specified columns.
```
```
Drop specified columns.
```
Protobuf type spark.connect.Drop
Annotations
@Generated()
final class DropGlobalTempView extends GeneratedMessage with DropGlobalTempViewOrBuilder
```
See `spark.catalog.dropGlobalTempView`
```
```
See `spark.catalog.dropGlobalTempView`
```
Protobuf type spark.connect.DropGlobalTempView
Annotations
@Generated()
trait DropGlobalTempViewOrBuilder extends MessageOrBuilder
Annotations
@Generated()
trait DropOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class DropTempView extends GeneratedMessage with DropTempViewOrBuilder
```
See `spark.catalog.dropTempView`
```
```
See `spark.catalog.dropTempView`
```
Protobuf type spark.connect.DropTempView
Annotations
@Generated()
trait DropTempViewOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ExamplePluginCommand extends GeneratedMessage with ExamplePluginCommandOrBuilder
Protobuf type spark.connect.ExamplePluginCommand
Protobuf type spark.connect.ExamplePluginCommand
Annotations
@Generated()
trait ExamplePluginCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ExamplePluginExpression extends GeneratedMessage with ExamplePluginExpressionOrBuilder
Protobuf type spark.connect.ExamplePluginExpression
Protobuf type spark.connect.ExamplePluginExpression
Annotations
@Generated()
trait ExamplePluginExpressionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ExamplePluginRelation extends GeneratedMessage with ExamplePluginRelationOrBuilder
Protobuf type spark.connect.ExamplePluginRelation
Protobuf type spark.connect.ExamplePluginRelation
Annotations
@Generated()
trait ExamplePluginRelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ExamplePlugins extends GeneratedFile
Annotations
@Generated()
final class ExecuteExternalCommand extends GeneratedMessage with ExecuteExternalCommandOrBuilder
```
Execute an arbitrary string command inside an external execution engine
```
```
Execute an arbitrary string command inside an external execution engine
```
Protobuf type spark.connect.ExecuteExternalCommand
Annotations
@Generated()
trait ExecuteExternalCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ExecutePlanRequest extends GeneratedMessage with ExecutePlanRequestOrBuilder
```
A request to be executed by the service.
```
```
A request to be executed by the service.
```
Protobuf type spark.connect.ExecutePlanRequest
Annotations
@Generated()
trait ExecutePlanRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()

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

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()

trait ExecutePlanResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ExecutorResourceRequest extends GeneratedMessage with ExecutorResourceRequestOrBuilder
```
An executor resource request.
```
```
An executor resource request.
```
Protobuf type spark.connect.ExecutorResourceRequest
Annotations
@Generated()
trait ExecutorResourceRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Expression extends GeneratedMessage with ExpressionOrBuilder

Expression used to refer to fields, functions and similar. This can be used everywhere
expressions in SQL appear.

Expression used to refer to fields, functions and similar. This can be used everywhere
expressions in SQL appear.

Protobuf type spark.connect.Expression

Annotations: @Generated()

final class ExpressionCommon extends GeneratedMessage with ExpressionCommonOrBuilder
Protobuf type spark.connect.ExpressionCommon
Protobuf type spark.connect.ExpressionCommon
Annotations
@Generated()
trait ExpressionCommonOrBuilder extends MessageOrBuilder
Annotations
@Generated()
trait ExpressionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Expressions extends GeneratedFile
Annotations
@Generated()

final class Fetch extends GeneratedMessage with FetchOrBuilder

Message for fetching attribute from object on the server side.
Fetch can be represented as a Relation or a ML command
Command: model.coefficients, model.summary.weightedPrecision which
returns the final literal result
Relation: model.summary.roc which returns a DataFrame (Relation)

Message for fetching attribute from object on the server side.
Fetch can be represented as a Relation or a ML command
Command: model.coefficients, model.summary.weightedPrecision which
returns the final literal result
Relation: model.summary.roc which returns a DataFrame (Relation)

Protobuf type spark.connect.Fetch

Annotations: @Generated()

final class FetchErrorDetailsRequest extends GeneratedMessage with FetchErrorDetailsRequestOrBuilder
Protobuf type spark.connect.FetchErrorDetailsRequest
Protobuf type spark.connect.FetchErrorDetailsRequest
Annotations
@Generated()
trait FetchErrorDetailsRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class FetchErrorDetailsResponse extends GeneratedMessage with FetchErrorDetailsResponseOrBuilder
```
Next ID: 5
```
```
Next ID: 5
```
Protobuf type spark.connect.FetchErrorDetailsResponse
Annotations
@Generated()
trait FetchErrorDetailsResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
trait FetchOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Filter extends GeneratedMessage with FilterOrBuilder

Relation that applies a boolean expression `condition` on each row of `input` to produce
the output result.

Relation that applies a boolean expression `condition` on each row of `input` to produce
the output result.

Protobuf type spark.connect.Filter

Annotations: @Generated()

trait FilterOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Floats extends GeneratedMessage with FloatsOrBuilder
Protobuf type spark.connect.Floats
Protobuf type spark.connect.Floats
Annotations
@Generated()
trait FloatsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class FunctionExists extends GeneratedMessage with FunctionExistsOrBuilder
```
See `spark.catalog.functionExists`
```
```
See `spark.catalog.functionExists`
```
Protobuf type spark.connect.FunctionExists
Annotations
@Generated()
trait FunctionExistsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class GetDatabase extends GeneratedMessage with GetDatabaseOrBuilder
```
See `spark.catalog.getDatabase`
```
```
See `spark.catalog.getDatabase`
```
Protobuf type spark.connect.GetDatabase
Annotations
@Generated()
trait GetDatabaseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class GetFunction extends GeneratedMessage with GetFunctionOrBuilder
```
See `spark.catalog.getFunction`
```
```
See `spark.catalog.getFunction`
```
Protobuf type spark.connect.GetFunction
Annotations
@Generated()
trait GetFunctionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class GetResourcesCommand extends GeneratedMessage with GetResourcesCommandOrBuilder
```
Command to get the output of 'SparkContext.resources'
```
```
Command to get the output of 'SparkContext.resources'
```
Protobuf type spark.connect.GetResourcesCommand
Annotations
@Generated()
trait GetResourcesCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class GetResourcesCommandResult extends GeneratedMessage with GetResourcesCommandResultOrBuilder
```
Response for command 'GetResourcesCommand'.
```
```
Response for command 'GetResourcesCommand'.
```
Protobuf type spark.connect.GetResourcesCommandResult
Annotations
@Generated()
trait GetResourcesCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class GetTable extends GeneratedMessage with GetTableOrBuilder
```
See `spark.catalog.getTable`
```
```
See `spark.catalog.getTable`
```
Protobuf type spark.connect.GetTable
Annotations
@Generated()
trait GetTableOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class GroupMap extends GeneratedMessage with GroupMapOrBuilder
Protobuf type spark.connect.GroupMap
Protobuf type spark.connect.GroupMap
Annotations
@Generated()
trait GroupMapOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Hint extends GeneratedMessage with HintOrBuilder

Specify a hint over a relation. Hint should have a name and optional parameters.

Specify a hint over a relation. Hint should have a name and optional parameters.

Protobuf type spark.connect.Hint

Annotations: @Generated()

trait HintOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class HtmlString extends GeneratedMessage with HtmlStringOrBuilder

Compose the string representing rows for output.
It will invoke 'Dataset.htmlString' to compute the results.

Compose the string representing rows for output.
It will invoke 'Dataset.htmlString' to compute the results.

Protobuf type spark.connect.HtmlString

Annotations: @Generated()

trait HtmlStringOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class InterruptRequest extends GeneratedMessage with InterruptRequestOrBuilder
Protobuf type spark.connect.InterruptRequest
Protobuf type spark.connect.InterruptRequest
Annotations
@Generated()
trait InterruptRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class InterruptResponse extends GeneratedMessage with InterruptResponseOrBuilder
```
Next ID: 4
```
```
Next ID: 4
```
Protobuf type spark.connect.InterruptResponse
Annotations
@Generated()
trait InterruptResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Ints extends GeneratedMessage with IntsOrBuilder
Protobuf type spark.connect.Ints
Protobuf type spark.connect.Ints
Annotations
@Generated()
trait IntsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class IsCached extends GeneratedMessage with IsCachedOrBuilder
```
See `spark.catalog.isCached`
```
```
See `spark.catalog.isCached`
```
Protobuf type spark.connect.IsCached
Annotations
@Generated()
trait IsCachedOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class JavaUDF extends GeneratedMessage with JavaUDFOrBuilder
Protobuf type spark.connect.JavaUDF
Protobuf type spark.connect.JavaUDF
Annotations
@Generated()
trait JavaUDFOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Join extends GeneratedMessage with JoinOrBuilder

Relation of type [[Join]].

`left` and `right` must be present.

Relation of type [[Join]].

`left` and `right` must be present.

Protobuf type spark.connect.Join

Annotations: @Generated()

trait JoinOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class JvmOrigin extends GeneratedMessage with JvmOriginOrBuilder
Protobuf type spark.connect.JvmOrigin
Protobuf type spark.connect.JvmOrigin
Annotations
@Generated()
trait JvmOriginOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class KeyValue extends GeneratedMessage with KeyValueOrBuilder
```
The key-value pair for the config request and response.
```
```
The key-value pair for the config request and response.
```
Protobuf type spark.connect.KeyValue
Annotations
@Generated()
trait KeyValueOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class LateralJoin extends GeneratedMessage with LateralJoinOrBuilder

Relation of type [[LateralJoin]].

`left` and `right` must be present.

Relation of type [[LateralJoin]].

`left` and `right` must be present.

Protobuf type spark.connect.LateralJoin

Annotations: @Generated()

trait LateralJoinOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Limit extends GeneratedMessage with LimitOrBuilder

Relation of type [[Limit]] that is used to `limit` rows from the input relation.

Relation of type [[Limit]] that is used to `limit` rows from the input relation.

Protobuf type spark.connect.Limit

Annotations: @Generated()

trait LimitOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ListCatalogs extends GeneratedMessage with ListCatalogsOrBuilder
```
See `spark.catalog.listCatalogs`
```
```
See `spark.catalog.listCatalogs`
```
Protobuf type spark.connect.ListCatalogs
Annotations
@Generated()
trait ListCatalogsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ListColumns extends GeneratedMessage with ListColumnsOrBuilder
```
See `spark.catalog.listColumns`
```
```
See `spark.catalog.listColumns`
```
Protobuf type spark.connect.ListColumns
Annotations
@Generated()
trait ListColumnsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ListDatabases extends GeneratedMessage with ListDatabasesOrBuilder
```
See `spark.catalog.listDatabases`
```
```
See `spark.catalog.listDatabases`
```
Protobuf type spark.connect.ListDatabases
Annotations
@Generated()
trait ListDatabasesOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ListFunctions extends GeneratedMessage with ListFunctionsOrBuilder
```
See `spark.catalog.listFunctions`
```
```
See `spark.catalog.listFunctions`
```
Protobuf type spark.connect.ListFunctions
Annotations
@Generated()
trait ListFunctionsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ListTables extends GeneratedMessage with ListTablesOrBuilder
```
See `spark.catalog.listTables`
```
```
See `spark.catalog.listTables`
```
Protobuf type spark.connect.ListTables
Annotations
@Generated()
trait ListTablesOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class LocalRelation extends GeneratedMessage with LocalRelationOrBuilder
```
A relation that does not need to be qualified by name.
```
```
A relation that does not need to be qualified by name.
```
Protobuf type spark.connect.LocalRelation
Annotations
@Generated()
trait LocalRelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Longs extends GeneratedMessage with LongsOrBuilder
Protobuf type spark.connect.Longs
Protobuf type spark.connect.Longs
Annotations
@Generated()
trait LongsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class MapPartitions extends GeneratedMessage with MapPartitionsOrBuilder
Protobuf type spark.connect.MapPartitions
Protobuf type spark.connect.MapPartitions
Annotations
@Generated()
trait MapPartitionsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class MergeAction extends GeneratedMessage with MergeActionOrBuilder
Protobuf type spark.connect.MergeAction
Protobuf type spark.connect.MergeAction
Annotations
@Generated()
trait MergeActionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class MergeIntoTableCommand extends GeneratedMessage with MergeIntoTableCommandOrBuilder
Protobuf type spark.connect.MergeIntoTableCommand
Protobuf type spark.connect.MergeIntoTableCommand
Annotations
@Generated()
trait MergeIntoTableCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Ml extends GeneratedFile
Annotations
@Generated()
final class MlCommand extends GeneratedMessage with MlCommandOrBuilder
```
Command for ML
```
```
Command for ML
```
Protobuf type spark.connect.MlCommand
Annotations
@Generated()
trait MlCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class MlCommandResult extends GeneratedMessage with MlCommandResultOrBuilder
```
The result of MlCommand
```
```
The result of MlCommand
```
Protobuf type spark.connect.MlCommandResult
Annotations
@Generated()
trait MlCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class MlCommon extends GeneratedFile
Annotations
@Generated()

final class MlOperator extends GeneratedMessage with MlOperatorOrBuilder

MLOperator represents the ML operators like (Estimator, Transformer or Evaluator)

MLOperator represents the ML operators like (Estimator, Transformer or Evaluator)

Protobuf type spark.connect.MlOperator

Annotations: @Generated()

trait MlOperatorOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class MlParams extends GeneratedMessage with MlParamsOrBuilder

MlParams stores param settings for ML Estimator / Transformer / Evaluator

MlParams stores param settings for ML Estimator / Transformer / Evaluator

Protobuf type spark.connect.MlParams

Annotations: @Generated()

trait MlParamsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class MlRelation extends GeneratedMessage with MlRelationOrBuilder
```
Relation to represent ML world
```
```
Relation to represent ML world
```
Protobuf type spark.connect.MlRelation
Annotations
@Generated()
trait MlRelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class NADrop extends GeneratedMessage with NADropOrBuilder

Drop rows containing null values.
It will invoke 'Dataset.na.drop' (same as 'DataFrameNaFunctions.drop') to compute the results.

Drop rows containing null values.
It will invoke 'Dataset.na.drop' (same as 'DataFrameNaFunctions.drop') to compute the results.

Protobuf type spark.connect.NADrop

Annotations: @Generated()

trait NADropOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class NAFill extends GeneratedMessage with NAFillOrBuilder

Replaces null values.
It will invoke 'Dataset.na.fill' (same as 'DataFrameNaFunctions.fill') to compute the results.
Following 3 parameter combinations are supported:
1, 'values' only contains 1 item, 'cols' is empty:
replaces null values in all type-compatible columns.
2, 'values' only contains 1 item, 'cols' is not empty:
replaces null values in specified columns.
3, 'values' contains more than 1 items, then 'cols' is required to have the same length:
replaces each specified column with corresponding value.

Replaces null values.
It will invoke 'Dataset.na.fill' (same as 'DataFrameNaFunctions.fill') to compute the results.
Following 3 parameter combinations are supported:
1, 'values' only contains 1 item, 'cols' is empty:
replaces null values in all type-compatible columns.
2, 'values' only contains 1 item, 'cols' is not empty:
replaces null values in specified columns.
3, 'values' contains more than 1 items, then 'cols' is required to have the same length:
replaces each specified column with corresponding value.

Protobuf type spark.connect.NAFill

Annotations: @Generated()

trait NAFillOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class NAReplace extends GeneratedMessage with NAReplaceOrBuilder

Replaces old values with the corresponding values.
It will invoke 'Dataset.na.replace' (same as 'DataFrameNaFunctions.replace')
to compute the results.

Replaces old values with the corresponding values.
It will invoke 'Dataset.na.replace' (same as 'DataFrameNaFunctions.replace')
to compute the results.

Protobuf type spark.connect.NAReplace

Annotations: @Generated()

trait NAReplaceOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class NamedArgumentExpression extends GeneratedMessage with NamedArgumentExpressionOrBuilder
Protobuf type spark.connect.NamedArgumentExpression
Protobuf type spark.connect.NamedArgumentExpression
Annotations
@Generated()
trait NamedArgumentExpressionOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class ObjectRef extends GeneratedMessage with ObjectRefOrBuilder

Represents a reference to the cached object which could be a model
or summary evaluated by a model

Represents a reference to the cached object which could be a model
or summary evaluated by a model

Protobuf type spark.connect.ObjectRef

Annotations: @Generated()

trait ObjectRefOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Offset extends GeneratedMessage with OffsetOrBuilder

Relation of type [[Offset]] that is used to read rows staring from the `offset` on
the input relation.

Relation of type [[Offset]] that is used to read rows staring from the `offset` on
the input relation.

Protobuf type spark.connect.Offset

Annotations: @Generated()

trait OffsetOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Origin extends GeneratedMessage with OriginOrBuilder
Protobuf type spark.connect.Origin
Protobuf type spark.connect.Origin
Annotations
@Generated()
trait OriginOrBuilder extends MessageOrBuilder
Annotations
@Generated()
sealed final class OutputType extends Enum[OutputType] with ProtocolMessageEnum
```
The type of output.
```
```
The type of output.
```
Protobuf enum spark.connect.OutputType
Annotations
@Generated()
final class Parse extends GeneratedMessage with ParseOrBuilder
Protobuf type spark.connect.Parse
Protobuf type spark.connect.Parse
Annotations
@Generated()
trait ParseOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class PipelineAnalysisContext extends GeneratedMessage with PipelineAnalysisContextOrBuilder

Metadata providing context about the pipeline during Spark Connect query analysis.

Metadata providing context about the pipeline during Spark Connect query analysis.

Protobuf type spark.connect.PipelineAnalysisContext

Annotations: @Generated()

trait PipelineAnalysisContextOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class PipelineCommand extends GeneratedMessage with PipelineCommandOrBuilder

Dispatch object for pipelines commands. See each individual command for documentation.

Dispatch object for pipelines commands. See each individual command for documentation.

Protobuf type spark.connect.PipelineCommand

Annotations: @Generated()

trait PipelineCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PipelineCommandResult extends GeneratedMessage with PipelineCommandResultOrBuilder
```
Dispatch object for pipelines command results.
```
```
Dispatch object for pipelines command results.
```
Protobuf type spark.connect.PipelineCommandResult
Annotations
@Generated()
trait PipelineCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PipelineEvent extends GeneratedMessage with PipelineEventOrBuilder
Protobuf type spark.connect.PipelineEvent
Protobuf type spark.connect.PipelineEvent
Annotations
@Generated()
trait PipelineEventOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PipelineEventResult extends GeneratedMessage with PipelineEventResultOrBuilder
```
A response containing an event emitted during the run of a pipeline.
```
```
A response containing an event emitted during the run of a pipeline.
```
Protobuf type spark.connect.PipelineEventResult
Annotations
@Generated()
trait PipelineEventResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class PipelineQueryFunctionExecutionSignal extends GeneratedMessage with PipelineQueryFunctionExecutionSignalOrBuilder

A signal from the server to the client to execute the query function for one or more flows, and
to register their results with the server.

A signal from the server to the client to execute the query function for one or more flows, and
to register their results with the server.

Protobuf type spark.connect.PipelineQueryFunctionExecutionSignal

Annotations: @Generated()

trait PipelineQueryFunctionExecutionSignalOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Pipelines extends GeneratedFile
Annotations
@Generated()

final class Plan extends GeneratedMessage with PlanOrBuilder

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

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

Protobuf type spark.connect.Plan

Annotations: @Generated()

trait PlanOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Project extends GeneratedMessage with ProjectOrBuilder

Projection of a bag of expressions for a given input relation.

The input relation must be specified.
The projected expression can be an arbitrary expression.

Projection of a bag of expressions for a given input relation.

The input relation must be specified.
The projected expression can be an arbitrary expression.

Protobuf type spark.connect.Project

Annotations: @Generated()

trait ProjectOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PythonDataSource extends GeneratedMessage with PythonDataSourceOrBuilder
Protobuf type spark.connect.PythonDataSource
Protobuf type spark.connect.PythonDataSource
Annotations
@Generated()
trait PythonDataSourceOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PythonOrigin extends GeneratedMessage with PythonOriginOrBuilder
Protobuf type spark.connect.PythonOrigin
Protobuf type spark.connect.PythonOrigin
Annotations
@Generated()
trait PythonOriginOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PythonUDF extends GeneratedMessage with PythonUDFOrBuilder
Protobuf type spark.connect.PythonUDF
Protobuf type spark.connect.PythonUDF
Annotations
@Generated()
trait PythonUDFOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class PythonUDTF extends GeneratedMessage with PythonUDTFOrBuilder
Protobuf type spark.connect.PythonUDTF
Protobuf type spark.connect.PythonUDTF
Annotations
@Generated()
trait PythonUDTFOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Range extends GeneratedMessage with RangeOrBuilder

Relation of type [[Range]] that generates a sequence of integers.

Relation of type [[Range]] that generates a sequence of integers.

Protobuf type spark.connect.Range

Annotations: @Generated()

trait RangeOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Read extends GeneratedMessage with ReadOrBuilder

Relation that reads from a file / table or other data source. Does not have additional
inputs.

Relation that reads from a file / table or other data source. Does not have additional
inputs.

Protobuf type spark.connect.Read

Annotations: @Generated()

trait ReadOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ReattachExecuteRequest extends GeneratedMessage with ReattachExecuteRequestOrBuilder
Protobuf type spark.connect.ReattachExecuteRequest
Protobuf type spark.connect.ReattachExecuteRequest
Annotations
@Generated()
trait ReattachExecuteRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ReattachOptions extends GeneratedMessage with ReattachOptionsOrBuilder
Protobuf type spark.connect.ReattachOptions
Protobuf type spark.connect.ReattachOptions
Annotations
@Generated()
trait ReattachOptionsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class RecoverPartitions extends GeneratedMessage with RecoverPartitionsOrBuilder
```
See `spark.catalog.recoverPartitions`
```
```
See `spark.catalog.recoverPartitions`
```
Protobuf type spark.connect.RecoverPartitions
Annotations
@Generated()
trait RecoverPartitionsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class RefreshByPath extends GeneratedMessage with RefreshByPathOrBuilder
```
See `spark.catalog.refreshByPath`
```
```
See `spark.catalog.refreshByPath`
```
Protobuf type spark.connect.RefreshByPath
Annotations
@Generated()
trait RefreshByPathOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class RefreshTable extends GeneratedMessage with RefreshTableOrBuilder
```
See `spark.catalog.refreshTable`
```
```
See `spark.catalog.refreshTable`
```
Protobuf type spark.connect.RefreshTable
Annotations
@Generated()
trait RefreshTableOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Relation extends GeneratedMessage with RelationOrBuilder

The main [[Relation]] type. Fundamentally, a relation is a typed container
that has exactly one explicit relation type set.

When adding new relation types, they have to be registered here.

The main [[Relation]] type. Fundamentally, a relation is a typed container
that has exactly one explicit relation type set.

When adding new relation types, they have to be registered here.

Protobuf type spark.connect.Relation

Annotations: @Generated()

final class RelationCommon extends GeneratedMessage with RelationCommonOrBuilder
```
Common metadata of all relations.
```
```
Common metadata of all relations.
```
Protobuf type spark.connect.RelationCommon
Annotations
@Generated()
trait RelationCommonOrBuilder extends MessageOrBuilder
Annotations
@Generated()
trait RelationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Relations extends GeneratedFile
Annotations
@Generated()
final class ReleaseExecuteRequest extends GeneratedMessage with ReleaseExecuteRequestOrBuilder
Protobuf type spark.connect.ReleaseExecuteRequest
Protobuf type spark.connect.ReleaseExecuteRequest
Annotations
@Generated()
trait ReleaseExecuteRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ReleaseExecuteResponse extends GeneratedMessage with ReleaseExecuteResponseOrBuilder
```
Next ID: 4
```
```
Next ID: 4
```
Protobuf type spark.connect.ReleaseExecuteResponse
Annotations
@Generated()
trait ReleaseExecuteResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ReleaseSessionRequest extends GeneratedMessage with ReleaseSessionRequestOrBuilder
Protobuf type spark.connect.ReleaseSessionRequest
Protobuf type spark.connect.ReleaseSessionRequest
Annotations
@Generated()
trait ReleaseSessionRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ReleaseSessionResponse extends GeneratedMessage with ReleaseSessionResponseOrBuilder
```
Next ID: 3
```
```
Next ID: 3
```
Protobuf type spark.connect.ReleaseSessionResponse
Annotations
@Generated()
trait ReleaseSessionResponseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class RemoveCachedRemoteRelationCommand extends GeneratedMessage with RemoveCachedRemoteRelationCommandOrBuilder
```
Command to remove `CashedRemoteRelation`
```
```
Command to remove `CashedRemoteRelation`
```
Protobuf type spark.connect.RemoveCachedRemoteRelationCommand
Annotations
@Generated()
trait RemoveCachedRemoteRelationCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Repartition extends GeneratedMessage with RepartitionOrBuilder
```
Relation repartition.
```
```
Relation repartition.
```
Protobuf type spark.connect.Repartition
Annotations
@Generated()
final class RepartitionByExpression extends GeneratedMessage with RepartitionByExpressionOrBuilder
Protobuf type spark.connect.RepartitionByExpression
Protobuf type spark.connect.RepartitionByExpression
Annotations
@Generated()
trait RepartitionByExpressionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
trait RepartitionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ResolvedIdentifier extends GeneratedMessage with ResolvedIdentifierOrBuilder
Protobuf type spark.connect.ResolvedIdentifier
Protobuf type spark.connect.ResolvedIdentifier
Annotations
@Generated()
trait ResolvedIdentifierOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class ResourceInformation extends GeneratedMessage with ResourceInformationOrBuilder

ResourceInformation to hold information about a type of Resource.
The corresponding class is 'org.apache.spark.resource.ResourceInformation'

ResourceInformation to hold information about a type of Resource.
The corresponding class is 'org.apache.spark.resource.ResourceInformation'

Protobuf type spark.connect.ResourceInformation

Annotations: @Generated()

trait ResourceInformationOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ResourceProfile extends GeneratedMessage with ResourceProfileOrBuilder
Protobuf type spark.connect.ResourceProfile
Protobuf type spark.connect.ResourceProfile
Annotations
@Generated()
trait ResourceProfileOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ResultChunkingOptions extends GeneratedMessage with ResultChunkingOptionsOrBuilder
Protobuf type spark.connect.ResultChunkingOptions
Protobuf type spark.connect.ResultChunkingOptions
Annotations
@Generated()
trait ResultChunkingOptionsOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class SQL extends GeneratedMessage with SQLOrBuilder

Relation that uses a SQL query to generate the output.

Relation that uses a SQL query to generate the output.

Protobuf type spark.connect.SQL

Annotations: @Generated()

trait SQLOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Sample extends GeneratedMessage with SampleOrBuilder

Relation of type [[Sample]] that samples a fraction of the dataset.

Relation of type [[Sample]] that samples a fraction of the dataset.

Protobuf type spark.connect.Sample

Annotations: @Generated()

trait SampleOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ScalarScalaUDF extends GeneratedMessage with ScalarScalaUDFOrBuilder
Protobuf type spark.connect.ScalarScalaUDF
Protobuf type spark.connect.ScalarScalaUDF
Annotations
@Generated()
trait ScalarScalaUDFOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class SetCurrentCatalog extends GeneratedMessage with SetCurrentCatalogOrBuilder
```
See `spark.catalog.setCurrentCatalog`
```
```
See `spark.catalog.setCurrentCatalog`
```
Protobuf type spark.connect.SetCurrentCatalog
Annotations
@Generated()
trait SetCurrentCatalogOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class SetCurrentDatabase extends GeneratedMessage with SetCurrentDatabaseOrBuilder
```
See `spark.catalog.setCurrentDatabase`
```
```
See `spark.catalog.setCurrentDatabase`
```
Protobuf type spark.connect.SetCurrentDatabase
Annotations
@Generated()
trait SetCurrentDatabaseOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class SetOperation extends GeneratedMessage with SetOperationOrBuilder
```
Relation of type [[SetOperation]]
```
```
Relation of type [[SetOperation]]
```
Protobuf type spark.connect.SetOperation
Annotations
@Generated()
trait SetOperationOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class ShowString extends GeneratedMessage with ShowStringOrBuilder

Compose the string representing rows for output.
It will invoke 'Dataset.showString' to compute the results.

Compose the string representing rows for output.
It will invoke 'Dataset.showString' to compute the results.

Protobuf type spark.connect.ShowString

Annotations: @Generated()

trait ShowStringOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Sort extends GeneratedMessage with SortOrBuilder
```
Relation of type [[Sort]].
```
```
Relation of type [[Sort]].
```
Protobuf type spark.connect.Sort
Annotations
@Generated()
trait SortOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class SourceCodeLocation extends GeneratedMessage with SourceCodeLocationOrBuilder

Source code location information associated with a particular dataset or flow.

Source code location information associated with a particular dataset or flow.

Protobuf type spark.connect.SourceCodeLocation

Annotations: @Generated()

trait SourceCodeLocationOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class SparkConnectServiceGrpc extends AnyRef

Main interface for the SparkConnect service.

Main interface for the SparkConnect service.

Annotations: @GrpcGenerated()

final class SqlCommand extends GeneratedMessage with SqlCommandOrBuilder

A SQL Command is used to trigger the eager evaluation of SQL commands in Spark.

When the SQL provide as part of the message is a command it will be immediately evaluated
and the result will be collected and returned as part of a LocalRelation. If the result is
not a command, the operation will simply return a SQL Relation. This allows the client to be
almost oblivious to the server-side behavior.

A SQL Command is used to trigger the eager evaluation of SQL commands in Spark.

When the SQL provide as part of the message is a command it will be immediately evaluated
and the result will be collected and returned as part of a LocalRelation. If the result is
not a command, the operation will simply return a SQL Relation. This allows the client to be
almost oblivious to the server-side behavior.

Protobuf type spark.connect.SqlCommand

Annotations: @Generated()

trait SqlCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StackTraceElement extends GeneratedMessage with StackTraceElementOrBuilder
```
A message to hold a [[java.lang.StackTraceElement]].
```
```
A message to hold a [[java.lang.StackTraceElement]].
```
Protobuf type spark.connect.StackTraceElement
Annotations
@Generated()
trait StackTraceElementOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatApproxQuantile extends GeneratedMessage with StatApproxQuantileOrBuilder

Calculates the approximate quantiles of numerical columns of a DataFrame.
It will invoke 'Dataset.stat.approxQuantile' (same as 'StatFunctions.approxQuantile')
to compute the results.

Calculates the approximate quantiles of numerical columns of a DataFrame.
It will invoke 'Dataset.stat.approxQuantile' (same as 'StatFunctions.approxQuantile')
to compute the results.

Protobuf type spark.connect.StatApproxQuantile

Annotations: @Generated()

trait StatApproxQuantileOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatCorr extends GeneratedMessage with StatCorrOrBuilder

Calculates the correlation of two columns of a DataFrame. Currently only supports the Pearson
Correlation Coefficient. It will invoke 'Dataset.stat.corr' (same as
'StatFunctions.pearsonCorrelation') to compute the results.

Calculates the correlation of two columns of a DataFrame. Currently only supports the Pearson
Correlation Coefficient. It will invoke 'Dataset.stat.corr' (same as
'StatFunctions.pearsonCorrelation') to compute the results.

Protobuf type spark.connect.StatCorr

Annotations: @Generated()

trait StatCorrOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatCov extends GeneratedMessage with StatCovOrBuilder

Calculate the sample covariance of two numerical columns of a DataFrame.
It will invoke 'Dataset.stat.cov' (same as 'StatFunctions.calculateCov') to compute the results.

Calculate the sample covariance of two numerical columns of a DataFrame.
It will invoke 'Dataset.stat.cov' (same as 'StatFunctions.calculateCov') to compute the results.

Protobuf type spark.connect.StatCov

Annotations: @Generated()

trait StatCovOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatCrosstab extends GeneratedMessage with StatCrosstabOrBuilder

Computes a pair-wise frequency table of the given columns. Also known as a contingency table.
It will invoke 'Dataset.stat.crosstab' (same as 'StatFunctions.crossTabulate')
to compute the results.

Computes a pair-wise frequency table of the given columns. Also known as a contingency table.
It will invoke 'Dataset.stat.crosstab' (same as 'StatFunctions.crossTabulate')
to compute the results.

Protobuf type spark.connect.StatCrosstab

Annotations: @Generated()

trait StatCrosstabOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatDescribe extends GeneratedMessage with StatDescribeOrBuilder

Computes basic statistics for numeric and string columns, including count, mean, stddev, min,
and max. If no columns are given, this function computes statistics for all numerical or
string columns.

Computes basic statistics for numeric and string columns, including count, mean, stddev, min,
and max. If no columns are given, this function computes statistics for all numerical or
string columns.

Protobuf type spark.connect.StatDescribe

Annotations: @Generated()

trait StatDescribeOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatFreqItems extends GeneratedMessage with StatFreqItemsOrBuilder

Finding frequent items for columns, possibly with false positives.
It will invoke 'Dataset.stat.freqItems' (same as 'StatFunctions.freqItems')
to compute the results.

Finding frequent items for columns, possibly with false positives.
It will invoke 'Dataset.stat.freqItems' (same as 'StatFunctions.freqItems')
to compute the results.

Protobuf type spark.connect.StatFreqItems

Annotations: @Generated()

trait StatFreqItemsOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatSampleBy extends GeneratedMessage with StatSampleByOrBuilder

Returns a stratified sample without replacement based on the fraction
given on each stratum.
It will invoke 'Dataset.stat.freqItems' (same as 'StatFunctions.freqItems')
to compute the results.

Returns a stratified sample without replacement based on the fraction
given on each stratum.
It will invoke 'Dataset.stat.freqItems' (same as 'StatFunctions.freqItems')
to compute the results.

Protobuf type spark.connect.StatSampleBy

Annotations: @Generated()

trait StatSampleByOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StatSummary extends GeneratedMessage with StatSummaryOrBuilder

Computes specified statistics for numeric and string columns.
It will invoke 'Dataset.summary' (same as 'StatFunctions.summary')
to compute the results.

Computes specified statistics for numeric and string columns.
It will invoke 'Dataset.summary' (same as 'StatFunctions.summary')
to compute the results.

Protobuf type spark.connect.StatSummary

Annotations: @Generated()

trait StatSummaryOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StorageLevel extends GeneratedMessage with StorageLevelOrBuilder
```
StorageLevel for persisting Datasets/Tables.
```
```
StorageLevel for persisting Datasets/Tables.
```
Protobuf type spark.connect.StorageLevel
Annotations
@Generated()
trait StorageLevelOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingForeachFunction extends GeneratedMessage with StreamingForeachFunctionOrBuilder
Protobuf type spark.connect.StreamingForeachFunction
Protobuf type spark.connect.StreamingForeachFunction
Annotations
@Generated()
trait StreamingForeachFunctionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingQueryCommand extends GeneratedMessage with StreamingQueryCommandOrBuilder
```
Commands for a streaming query.
```
```
Commands for a streaming query.
```
Protobuf type spark.connect.StreamingQueryCommand
Annotations
@Generated()
trait StreamingQueryCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingQueryCommandResult extends GeneratedMessage with StreamingQueryCommandResultOrBuilder
```
Response for commands on a streaming query.
```
```
Response for commands on a streaming query.
```
Protobuf type spark.connect.StreamingQueryCommandResult
Annotations
@Generated()
trait StreamingQueryCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()

sealed final class StreamingQueryEventType extends Enum[StreamingQueryEventType] with ProtocolMessageEnum

The enum used for client side streaming query listener event
There is no QueryStartedEvent defined here,
it is added as a field in WriteStreamOperationStartResult

The enum used for client side streaming query listener event
There is no QueryStartedEvent defined here,
it is added as a field in WriteStreamOperationStartResult

Protobuf enum spark.connect.StreamingQueryEventType

Annotations: @Generated()

final class StreamingQueryInstanceId extends GeneratedMessage with StreamingQueryInstanceIdOrBuilder

A tuple that uniquely identifies an instance of streaming query run. It consists of `id` that
persists across the streaming runs and `run_id` that changes between each run of the
streaming query that resumes from the checkpoint.

A tuple that uniquely identifies an instance of streaming query run. It consists of `id` that
persists across the streaming runs and `run_id` that changes between each run of the
streaming query that resumes from the checkpoint.

Protobuf type spark.connect.StreamingQueryInstanceId

Annotations: @Generated()

trait StreamingQueryInstanceIdOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class StreamingQueryListenerBusCommand extends GeneratedMessage with StreamingQueryListenerBusCommandOrBuilder

The protocol for client-side StreamingQueryListener.
This command will only be set when either the first listener is added to the client, or the last
listener is removed from the client.
The add_listener_bus_listener command will only be set true in the first case.
The remove_listener_bus_listener command will only be set true in the second case.

The protocol for client-side StreamingQueryListener.
This command will only be set when either the first listener is added to the client, or the last
listener is removed from the client.
The add_listener_bus_listener command will only be set true in the first case.
The remove_listener_bus_listener command will only be set true in the second case.

Protobuf type spark.connect.StreamingQueryListenerBusCommand

Annotations: @Generated()

trait StreamingQueryListenerBusCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingQueryListenerEvent extends GeneratedMessage with StreamingQueryListenerEventOrBuilder
```
The protocol for the returned events in the long-running response channel.
```
```
The protocol for the returned events in the long-running response channel.
```
Protobuf type spark.connect.StreamingQueryListenerEvent
Annotations
@Generated()
trait StreamingQueryListenerEventOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingQueryListenerEventsResult extends GeneratedMessage with StreamingQueryListenerEventsResultOrBuilder
Protobuf type spark.connect.StreamingQueryListenerEventsResult
Protobuf type spark.connect.StreamingQueryListenerEventsResult
Annotations
@Generated()
trait StreamingQueryListenerEventsResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingQueryManagerCommand extends GeneratedMessage with StreamingQueryManagerCommandOrBuilder
```
Commands for the streaming query manager.
```
```
Commands for the streaming query manager.
```
Protobuf type spark.connect.StreamingQueryManagerCommand
Annotations
@Generated()
trait StreamingQueryManagerCommandOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class StreamingQueryManagerCommandResult extends GeneratedMessage with StreamingQueryManagerCommandResultOrBuilder
```
Response for commands on the streaming query manager.
```
```
Response for commands on the streaming query manager.
```
Protobuf type spark.connect.StreamingQueryManagerCommandResult
Annotations
@Generated()
trait StreamingQueryManagerCommandResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Strings extends GeneratedMessage with StringsOrBuilder
Protobuf type spark.connect.Strings
Protobuf type spark.connect.Strings
Annotations
@Generated()
trait StringsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class SubqueryAlias extends GeneratedMessage with SubqueryAliasOrBuilder
```
Relation alias.
```
```
Relation alias.
```
Protobuf type spark.connect.SubqueryAlias
Annotations
@Generated()
trait SubqueryAliasOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class SubqueryExpression extends GeneratedMessage with SubqueryExpressionOrBuilder
Protobuf type spark.connect.SubqueryExpression
Protobuf type spark.connect.SubqueryExpression
Annotations
@Generated()
trait SubqueryExpressionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class TableExists extends GeneratedMessage with TableExistsOrBuilder
```
See `spark.catalog.tableExists`
```
```
See `spark.catalog.tableExists`
```
Protobuf type spark.connect.TableExists
Annotations
@Generated()
trait TableExistsOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Tail extends GeneratedMessage with TailOrBuilder

Relation of type [[Tail]] that is used to fetch `limit` rows from the last of the input relation.

Relation of type [[Tail]] that is used to fetch `limit` rows from the last of the input relation.

Protobuf type spark.connect.Tail

Annotations: @Generated()

trait TailOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class TaskResourceRequest extends GeneratedMessage with TaskResourceRequestOrBuilder
```
A task resource request.
```
```
A task resource request.
```
Protobuf type spark.connect.TaskResourceRequest
Annotations
@Generated()
trait TaskResourceRequestOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class ToDF extends GeneratedMessage with ToDFOrBuilder

Rename columns on the input relation by the same length of names.

Rename columns on the input relation by the same length of names.

Protobuf type spark.connect.ToDF

Annotations: @Generated()

trait ToDFOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class ToSchema extends GeneratedMessage with ToSchemaOrBuilder
Protobuf type spark.connect.ToSchema
Protobuf type spark.connect.ToSchema
Annotations
@Generated()
trait ToSchemaOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class TransformWithStateInfo extends GeneratedMessage with TransformWithStateInfoOrBuilder
```
Additional input parameters used for TransformWithState operator.
```
```
Additional input parameters used for TransformWithState operator.
```
Protobuf type spark.connect.TransformWithStateInfo
Annotations
@Generated()
trait TransformWithStateInfoOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Transpose extends GeneratedMessage with TransposeOrBuilder

Transpose a DataFrame, switching rows to columns.
Transforms the DataFrame such that the values in the specified index column
become the new columns of the DataFrame.

Transpose a DataFrame, switching rows to columns.
Transforms the DataFrame such that the values in the specified index column
become the new columns of the DataFrame.

Protobuf type spark.connect.Transpose

Annotations: @Generated()

trait TransposeOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class TypedAggregateExpression extends GeneratedMessage with TypedAggregateExpressionOrBuilder
Protobuf type spark.connect.TypedAggregateExpression
Protobuf type spark.connect.TypedAggregateExpression
Annotations
@Generated()
trait TypedAggregateExpressionOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Types extends GeneratedFile
Annotations
@Generated()
final class UncacheTable extends GeneratedMessage with UncacheTableOrBuilder
```
See `spark.catalog.uncacheTable`
```
```
See `spark.catalog.uncacheTable`
```
Protobuf type spark.connect.UncacheTable
Annotations
@Generated()
trait UncacheTableOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class Unknown extends GeneratedMessage with UnknownOrBuilder
```
Used for testing purposes only.
```
```
Used for testing purposes only.
```
Protobuf type spark.connect.Unknown
Annotations
@Generated()
trait UnknownOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class Unpivot extends GeneratedMessage with UnpivotOrBuilder

Unpivot a DataFrame from wide format to long format, optionally leaving identifier columns set.

Unpivot a DataFrame from wide format to long format, optionally leaving identifier columns set.

Protobuf type spark.connect.Unpivot

Annotations: @Generated()

trait UnpivotOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class UnresolvedTableValuedFunction extends GeneratedMessage with UnresolvedTableValuedFunctionOrBuilder
Protobuf type spark.connect.UnresolvedTableValuedFunction
Protobuf type spark.connect.UnresolvedTableValuedFunction
Annotations
@Generated()
trait UnresolvedTableValuedFunctionOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class UserContext extends GeneratedMessage with UserContextOrBuilder

User Context is used to refer to one particular user session that is executing
queries in the backend.

User Context is used to refer to one particular user session that is executing
queries in the backend.

Protobuf type spark.connect.UserContext

Annotations: @Generated()

trait UserContextOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class WithColumns extends GeneratedMessage with WithColumnsOrBuilder

Adding columns or replacing the existing columns that have the same names.

Adding columns or replacing the existing columns that have the same names.

Protobuf type spark.connect.WithColumns

Annotations: @Generated()

trait WithColumnsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class WithColumnsRenamed extends GeneratedMessage with WithColumnsRenamedOrBuilder
```
Rename columns on the input relation by a map with name to name mapping.
```
```
Rename columns on the input relation by a map with name to name mapping.
```
Protobuf type spark.connect.WithColumnsRenamed
Annotations
@Generated()
trait WithColumnsRenamedOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class WithRelations extends GeneratedMessage with WithRelationsOrBuilder

Relation of type [[WithRelations]].

This relation contains a root plan, and one or more references that are used by the root plan.
There are two ways of referencing a relation, by name (through a subquery alias), or by plan_id
(using RelationCommon.plan_id).

This relation can be used to implement CTEs, describe DAGs, or to reduce tree depth.

Relation of type [[WithRelations]].

This relation contains a root plan, and one or more references that are used by the root plan.
There are two ways of referencing a relation, by name (through a subquery alias), or by plan_id
(using RelationCommon.plan_id).

This relation can be used to implement CTEs, describe DAGs, or to reduce tree depth.

Protobuf type spark.connect.WithRelations

Annotations: @Generated()

trait WithRelationsOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class WithWatermark extends GeneratedMessage with WithWatermarkOrBuilder
Protobuf type spark.connect.WithWatermark
Protobuf type spark.connect.WithWatermark
Annotations
@Generated()
trait WithWatermarkOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class WriteOperation extends GeneratedMessage with WriteOperationOrBuilder

As writes are not directly handled during analysis and planning, they are modeled as commands.

As writes are not directly handled during analysis and planning, they are modeled as commands.

Protobuf type spark.connect.WriteOperation

Annotations: @Generated()

trait WriteOperationOrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class WriteOperationV2 extends GeneratedMessage with WriteOperationV2OrBuilder

As writes are not directly handled during analysis and planning, they are modeled as commands.

As writes are not directly handled during analysis and planning, they are modeled as commands.

Protobuf type spark.connect.WriteOperationV2

Annotations: @Generated()

trait WriteOperationV2OrBuilder extends MessageOrBuilder
Annotations
@Generated()

final class WriteStreamOperationStart extends GeneratedMessage with WriteStreamOperationStartOrBuilder

Starts write stream operation as streaming query. Query ID and Run ID of the streaming
query are returned.

Starts write stream operation as streaming query. Query ID and Run ID of the streaming
query are returned.

Protobuf type spark.connect.WriteStreamOperationStart

Annotations: @Generated()

trait WriteStreamOperationStartOrBuilder extends MessageOrBuilder
Annotations
@Generated()
final class WriteStreamOperationStartResult extends GeneratedMessage with WriteStreamOperationStartResultOrBuilder
Protobuf type spark.connect.WriteStreamOperationStartResult
Protobuf type spark.connect.WriteStreamOperationStartResult
Annotations
@Generated()
trait WriteStreamOperationStartResultOrBuilder extends MessageOrBuilder
Annotations
@Generated()

Packages

proto

package proto

Type Members

Ungrouped

Packages

proto

package proto

Type Members

Ungrouped

proto