Packages

c

org.apache.spark.connect.proto

ExecutePlanRequest

final class ExecutePlanRequest extends GeneratedMessage with ExecutePlanRequestOrBuilder

A request to be executed by the service.

Protobuf type spark.connect.ExecutePlanRequest

Linear Supertypes
ExecutePlanRequestOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecutePlanRequest
  2. ExecutePlanRequestOrBuilder
  3. GeneratedMessage
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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(obj: AnyRef): Boolean
    Definition Classes
    ExecutePlanRequest → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. 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 = 8;

    returns

    The clientObservedServerSideSessionId.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  12. 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 = 8;

    returns

    The bytes for clientObservedServerSideSessionId.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  13. 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 = 4;

    returns

    The clientType.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  14. 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 = 4;

    returns

    The bytes for clientType.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  15. def getDefaultInstanceForType(): ExecutePlanRequest
    Definition Classes
    ExecutePlanRequest → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  16. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  17. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  20. def getOperationId(): String

    (Optional)
Provide an id for this request. If not provided, it will be generated by the server.
It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream.
The id must be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Optional)
Provide an id for this request. If not provided, it will be generated by the server.
It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream.
The id must be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    optional string operation_id = 6;

    returns

    The operationId.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  21. def getOperationIdBytes(): ByteString

    (Optional)
Provide an id for this request. If not provided, it will be generated by the server.
It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream.
The id must be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Optional)
Provide an id for this request. If not provided, it will be generated by the server.
It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream.
The id must be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    optional string operation_id = 6;

    returns

    The bytes for operationId.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  22. def getParserForType(): Parser[ExecutePlanRequest]
    Definition Classes
    ExecutePlanRequest → GeneratedMessage → Message → MessageLite
    Annotations
    @Override()
  23. def getPlan(): Plan

    (Required) The logical plan to be executed / analyzed.


    (Required) The logical plan to be executed / analyzed.

    .spark.connect.Plan plan = 3;

    returns

    The plan.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  24. def getPlanOrBuilder(): PlanOrBuilder

    (Required) The logical plan to be executed / analyzed.


    (Required) The logical plan to be executed / analyzed.

    .spark.connect.Plan plan = 3;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  25. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  26. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  27. def getRequestOptions(index: Int): RequestOption

    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.


    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.

    repeated .spark.connect.ExecutePlanRequest.RequestOption request_options = 5;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  28. def getRequestOptionsCount(): Int

    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.


    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.

    repeated .spark.connect.ExecutePlanRequest.RequestOption request_options = 5;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  29. def getRequestOptionsList(): List[RequestOption]

    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.


    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.

    repeated .spark.connect.ExecutePlanRequest.RequestOption request_options = 5;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  30. def getRequestOptionsOrBuilder(index: Int): RequestOptionOrBuilder

    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.


    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.

    repeated .spark.connect.ExecutePlanRequest.RequestOption request_options = 5;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  31. def getRequestOptionsOrBuilderList(): List[_ <: RequestOptionOrBuilder]

    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.


    Repeated element for options that can be passed to the request. This element is currently
unused but allows to pass in an extension value used for arbitrary options.

    repeated .spark.connect.ExecutePlanRequest.RequestOption request_options = 5;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  32. def getSerializedSize(): Int
    Definition Classes
    ExecutePlanRequest → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  33. 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.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  34. 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.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  35. def getTags(index: Int): String

    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.


    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.

    repeated string tags = 7;

    index

    The index of the element to return.

    returns

    The tags at the given index.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
  36. def getTagsBytes(index: Int): ByteString

    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.


    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.

    repeated string tags = 7;

    index

    The index of the value to return.

    returns

    The bytes of the tags at the given index.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
  37. def getTagsCount(): Int

    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.


    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.

    repeated string tags = 7;

    returns

    The count of tags.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
  38. def getTagsList(): ProtocolStringList

    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.


    Tags to tag the given execution with.
Tags cannot contain ',' character and cannot be empty strings.
Used by Interrupt with interrupt.tag.

    repeated string tags = 7;

    returns

    A list containing the tags.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
  39. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  40. def getUserContext(): UserContext

    (Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the
server side.


    (Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the
server side.

    .spark.connect.UserContext user_context = 2;

    returns

    The userContext.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  41. def getUserContextOrBuilder(): UserContextOrBuilder

    (Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the
server side.


    (Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the
server side.

    .spark.connect.UserContext user_context = 2;

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  42. 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 = 8;

    returns

    Whether the clientObservedServerSideSessionId field is set.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  43. 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 = 4;

    returns

    Whether the clientType field is set.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  44. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  45. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  46. def hasOperationId(): Boolean

    (Optional)
Provide an id for this request. If not provided, it will be generated by the server.
It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream.
The id must be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Optional)
Provide an id for this request. If not provided, it will be generated by the server.
It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream.
The id must be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    optional string operation_id = 6;

    returns

    Whether the operationId field is set.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  47. def hasPlan(): Boolean

    (Required) The logical plan to be executed / analyzed.


    (Required) The logical plan to be executed / analyzed.

    .spark.connect.Plan plan = 3;

    returns

    Whether the plan field is set.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  48. def hasUserContext(): Boolean

    (Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the
server side.


    (Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the
server side.

    .spark.connect.UserContext user_context = 2;

    returns

    Whether the userContext field is set.

    Definition Classes
    ExecutePlanRequest → ExecutePlanRequestOrBuilder
    Annotations
    @Override()
  49. def hashCode(): Int
    Definition Classes
    ExecutePlanRequest → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  50. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    ExecutePlanRequest → GeneratedMessage
    Annotations
    @Override()
  51. def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  52. final def isInitialized(): Boolean
    Definition Classes
    ExecutePlanRequest → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    ExecutePlanRequest → AbstractMessage
    Annotations
    @Override()
  56. def newBuilderForType(): Builder
    Definition Classes
    ExecutePlanRequest → Message → MessageLite
    Annotations
    @Override()
  57. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  60. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  61. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def toBuilder(): Builder
    Definition Classes
    ExecutePlanRequest → Message → MessageLite
    Annotations
    @Override()
  64. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  65. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  66. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  71. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  72. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    ExecutePlanRequest → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  73. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

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

    (Since version 9)

  2. def internalGetMapField(fieldNumber: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @Deprecated
    Deprecated
  3. def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from ExecutePlanRequestOrBuilder

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped