Packages

t

org.apache.spark.connect.proto

AnalyzePlanRequestOrBuilder

trait AnalyzePlanRequestOrBuilder extends MessageOrBuilder

Linear Supertypes
MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any
Known Subclasses
AnalyzePlanRequest
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnalyzePlanRequestOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAnalyzeCase(): AnalyzeCase
  4. abstract def getClientObservedServerSideSessionId(): String

    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.


    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.

    optional string client_observed_server_side_session_id = 17;

    returns

    The clientObservedServerSideSessionId.

  5. abstract def getClientObservedServerSideSessionIdBytes(): ByteString

    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.


    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.

    optional string client_observed_server_side_session_id = 17;

    returns

    The bytes for clientObservedServerSideSessionId.

  6. abstract def getClientType(): String

    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.


    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.

    optional string client_type = 3;

    returns

    The clientType.

  7. abstract def getClientTypeBytes(): ByteString

    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.


    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.

    optional string client_type = 3;

    returns

    The bytes for clientType.

  8. abstract def getDdlParse(): DDLParse

    .spark.connect.AnalyzePlanRequest.DDLParse ddl_parse = 11;

    .spark.connect.AnalyzePlanRequest.DDLParse ddl_parse = 11;

    returns

    The ddlParse.

  9. abstract def getDdlParseOrBuilder(): DDLParseOrBuilder

    .spark.connect.AnalyzePlanRequest.DDLParse ddl_parse = 11;

  10. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  11. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  12. abstract def getExplain(): Explain

    .spark.connect.AnalyzePlanRequest.Explain explain = 5;

    .spark.connect.AnalyzePlanRequest.Explain explain = 5;

    returns

    The explain.

  13. abstract def getExplainOrBuilder(): ExplainOrBuilder

    .spark.connect.AnalyzePlanRequest.Explain explain = 5;

  14. abstract def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  15. abstract def getGetStorageLevel(): GetStorageLevel

    .spark.connect.AnalyzePlanRequest.GetStorageLevel get_storage_level = 16;

    .spark.connect.AnalyzePlanRequest.GetStorageLevel get_storage_level = 16;

    returns

    The getStorageLevel.

  16. abstract def getGetStorageLevelOrBuilder(): GetStorageLevelOrBuilder

    .spark.connect.AnalyzePlanRequest.GetStorageLevel get_storage_level = 16;

  17. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  18. abstract def getInputFiles(): InputFiles

    .spark.connect.AnalyzePlanRequest.InputFiles input_files = 9;

    .spark.connect.AnalyzePlanRequest.InputFiles input_files = 9;

    returns

    The inputFiles.

  19. abstract def getInputFilesOrBuilder(): InputFilesOrBuilder

    .spark.connect.AnalyzePlanRequest.InputFiles input_files = 9;

  20. abstract def getIsLocal(): IsLocal

    .spark.connect.AnalyzePlanRequest.IsLocal is_local = 7;

    .spark.connect.AnalyzePlanRequest.IsLocal is_local = 7;

    returns

    The isLocal.

  21. abstract def getIsLocalOrBuilder(): IsLocalOrBuilder

    .spark.connect.AnalyzePlanRequest.IsLocal is_local = 7;

  22. abstract def getIsStreaming(): IsStreaming

    .spark.connect.AnalyzePlanRequest.IsStreaming is_streaming = 8;

    .spark.connect.AnalyzePlanRequest.IsStreaming is_streaming = 8;

    returns

    The isStreaming.

  23. abstract def getIsStreamingOrBuilder(): IsStreamingOrBuilder

    .spark.connect.AnalyzePlanRequest.IsStreaming is_streaming = 8;

  24. abstract def getJsonToDdl(): JsonToDDL

    .spark.connect.AnalyzePlanRequest.JsonToDDL json_to_ddl = 18;

    .spark.connect.AnalyzePlanRequest.JsonToDDL json_to_ddl = 18;

    returns

    The jsonToDdl.

  25. abstract def getJsonToDdlOrBuilder(): JsonToDDLOrBuilder

    .spark.connect.AnalyzePlanRequest.JsonToDDL json_to_ddl = 18;

  26. abstract def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  27. abstract def getPersist(): Persist

    .spark.connect.AnalyzePlanRequest.Persist persist = 14;

    .spark.connect.AnalyzePlanRequest.Persist persist = 14;

    returns

    The persist.

  28. abstract def getPersistOrBuilder(): PersistOrBuilder

    .spark.connect.AnalyzePlanRequest.Persist persist = 14;

  29. abstract def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  30. abstract def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  31. abstract def getSameSemantics(): SameSemantics

    .spark.connect.AnalyzePlanRequest.SameSemantics same_semantics = 12;

    .spark.connect.AnalyzePlanRequest.SameSemantics same_semantics = 12;

    returns

    The sameSemantics.

  32. abstract def getSameSemanticsOrBuilder(): SameSemanticsOrBuilder

    .spark.connect.AnalyzePlanRequest.SameSemantics same_semantics = 12;

  33. abstract def getSchema(): Schema

    .spark.connect.AnalyzePlanRequest.Schema schema = 4;

    .spark.connect.AnalyzePlanRequest.Schema schema = 4;

    returns

    The schema.

  34. abstract def getSchemaOrBuilder(): SchemaOrBuilder

    .spark.connect.AnalyzePlanRequest.Schema schema = 4;

  35. abstract def getSemanticHash(): SemanticHash

    .spark.connect.AnalyzePlanRequest.SemanticHash semantic_hash = 13;

    .spark.connect.AnalyzePlanRequest.SemanticHash semantic_hash = 13;

    returns

    The semanticHash.

  36. abstract def getSemanticHashOrBuilder(): SemanticHashOrBuilder

    .spark.connect.AnalyzePlanRequest.SemanticHash semantic_hash = 13;

  37. abstract def getSessionId(): String

    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    string session_id = 1;

    returns

    The sessionId.

  38. abstract def getSessionIdBytes(): ByteString

    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    string session_id = 1;

    returns

    The bytes for sessionId.

  39. abstract def getSparkVersion(): SparkVersion

    .spark.connect.AnalyzePlanRequest.SparkVersion spark_version = 10;

    .spark.connect.AnalyzePlanRequest.SparkVersion spark_version = 10;

    returns

    The sparkVersion.

  40. abstract def getSparkVersionOrBuilder(): SparkVersionOrBuilder

    .spark.connect.AnalyzePlanRequest.SparkVersion spark_version = 10;

  41. abstract def getTreeString(): TreeString

    .spark.connect.AnalyzePlanRequest.TreeString tree_string = 6;

    .spark.connect.AnalyzePlanRequest.TreeString tree_string = 6;

    returns

    The treeString.

  42. abstract def getTreeStringOrBuilder(): TreeStringOrBuilder

    .spark.connect.AnalyzePlanRequest.TreeString tree_string = 6;

  43. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  44. abstract def getUnpersist(): Unpersist

    .spark.connect.AnalyzePlanRequest.Unpersist unpersist = 15;

    .spark.connect.AnalyzePlanRequest.Unpersist unpersist = 15;

    returns

    The unpersist.

  45. abstract def getUnpersistOrBuilder(): UnpersistOrBuilder

    .spark.connect.AnalyzePlanRequest.Unpersist unpersist = 15;

  46. abstract def getUserContext(): UserContext

    (Required) User context


    (Required) User context

    .spark.connect.UserContext user_context = 2;

    returns

    The userContext.

  47. abstract def getUserContextOrBuilder(): UserContextOrBuilder

    (Required) User context


    (Required) User context

    .spark.connect.UserContext user_context = 2;

  48. abstract def hasClientObservedServerSideSessionId(): Boolean

    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.


    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.

    optional string client_observed_server_side_session_id = 17;

    returns

    Whether the clientObservedServerSideSessionId field is set.

  49. abstract def hasClientType(): Boolean

    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.


    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.

    optional string client_type = 3;

    returns

    Whether the clientType field is set.

  50. abstract def hasDdlParse(): Boolean

    .spark.connect.AnalyzePlanRequest.DDLParse ddl_parse = 11;

    .spark.connect.AnalyzePlanRequest.DDLParse ddl_parse = 11;

    returns

    Whether the ddlParse field is set.

  51. abstract def hasExplain(): Boolean

    .spark.connect.AnalyzePlanRequest.Explain explain = 5;

    .spark.connect.AnalyzePlanRequest.Explain explain = 5;

    returns

    Whether the explain field is set.

  52. abstract def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  53. abstract def hasGetStorageLevel(): Boolean

    .spark.connect.AnalyzePlanRequest.GetStorageLevel get_storage_level = 16;

    .spark.connect.AnalyzePlanRequest.GetStorageLevel get_storage_level = 16;

    returns

    Whether the getStorageLevel field is set.

  54. abstract def hasInputFiles(): Boolean

    .spark.connect.AnalyzePlanRequest.InputFiles input_files = 9;

    .spark.connect.AnalyzePlanRequest.InputFiles input_files = 9;

    returns

    Whether the inputFiles field is set.

  55. abstract def hasIsLocal(): Boolean

    .spark.connect.AnalyzePlanRequest.IsLocal is_local = 7;

    .spark.connect.AnalyzePlanRequest.IsLocal is_local = 7;

    returns

    Whether the isLocal field is set.

  56. abstract def hasIsStreaming(): Boolean

    .spark.connect.AnalyzePlanRequest.IsStreaming is_streaming = 8;

    .spark.connect.AnalyzePlanRequest.IsStreaming is_streaming = 8;

    returns

    Whether the isStreaming field is set.

  57. abstract def hasJsonToDdl(): Boolean

    .spark.connect.AnalyzePlanRequest.JsonToDDL json_to_ddl = 18;

    .spark.connect.AnalyzePlanRequest.JsonToDDL json_to_ddl = 18;

    returns

    Whether the jsonToDdl field is set.

  58. abstract def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  59. abstract def hasPersist(): Boolean

    .spark.connect.AnalyzePlanRequest.Persist persist = 14;

    .spark.connect.AnalyzePlanRequest.Persist persist = 14;

    returns

    Whether the persist field is set.

  60. abstract def hasSameSemantics(): Boolean

    .spark.connect.AnalyzePlanRequest.SameSemantics same_semantics = 12;

    .spark.connect.AnalyzePlanRequest.SameSemantics same_semantics = 12;

    returns

    Whether the sameSemantics field is set.

  61. abstract def hasSchema(): Boolean

    .spark.connect.AnalyzePlanRequest.Schema schema = 4;

    .spark.connect.AnalyzePlanRequest.Schema schema = 4;

    returns

    Whether the schema field is set.

  62. abstract def hasSemanticHash(): Boolean

    .spark.connect.AnalyzePlanRequest.SemanticHash semantic_hash = 13;

    .spark.connect.AnalyzePlanRequest.SemanticHash semantic_hash = 13;

    returns

    Whether the semanticHash field is set.

  63. abstract def hasSparkVersion(): Boolean

    .spark.connect.AnalyzePlanRequest.SparkVersion spark_version = 10;

    .spark.connect.AnalyzePlanRequest.SparkVersion spark_version = 10;

    returns

    Whether the sparkVersion field is set.

  64. abstract def hasTreeString(): Boolean

    .spark.connect.AnalyzePlanRequest.TreeString tree_string = 6;

    .spark.connect.AnalyzePlanRequest.TreeString tree_string = 6;

    returns

    Whether the treeString field is set.

  65. abstract def hasUnpersist(): Boolean

    .spark.connect.AnalyzePlanRequest.Unpersist unpersist = 15;

    .spark.connect.AnalyzePlanRequest.Unpersist unpersist = 15;

    returns

    Whether the unpersist field is set.

  66. abstract def hasUserContext(): Boolean

    (Required) User context


    (Required) User context

    .spark.connect.UserContext user_context = 2;

    returns

    Whether the userContext field is set.

  67. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped