Packages

t

org.apache.spark.connect.proto

ExecutePlanRequestOrBuilder

trait ExecutePlanRequestOrBuilder extends MessageOrBuilder

Linear Supertypes
MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any
Known Subclasses
ExecutePlanRequest
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecutePlanRequestOrBuilder
  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 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.

  4. 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 = 4;

    returns

    The bytes for clientType.

  5. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  6. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  7. abstract def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  8. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  9. abstract def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  10. abstract 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.

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

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

  13. abstract def getPlanOrBuilder(): PlanOrBuilder

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


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

    .spark.connect.Plan plan = 3;

  14. abstract def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  15. abstract def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  16. abstract 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;

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

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

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

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

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

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

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

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

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

  26. abstract def getTagsList(): List[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;

    returns

    A list containing the tags.

  27. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  28. abstract 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.

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

  30. 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 = 4;

    returns

    Whether the clientType field is set.

  31. abstract def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  32. abstract def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  33. abstract 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.

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

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

  36. 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]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped