Packages

c

org.apache.spark.connect.proto

ResultChunkingOptions

final class ResultChunkingOptions extends GeneratedMessage with ResultChunkingOptionsOrBuilder

Protobuf type spark.connect.ResultChunkingOptions

Annotations
@Generated()
Linear Supertypes
ResultChunkingOptionsOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResultChunkingOptions
  2. ResultChunkingOptionsOrBuilder
  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
    ResultChunkingOptions → 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. def getAllowArrowBatchChunking(): Boolean

    Although Arrow results are split into batches with a size limit according to estimation, the
    size of the batches is not guaranteed to be less than the limit, especially when a single row
    is larger than the limit, in which case the server will fail to split it further into smaller
    batches. As a result, the client may encounter a gRPC error stating “Received message larger
    than max” when a batch is too large.
    If allow_arrow_batch_chunking=true, the server will split large Arrow batches into smaller chunks,
    and the client is expected to handle the chunked Arrow batches.
    
    If false, the server will not chunk large Arrow batches.
    

    Although Arrow results are split into batches with a size limit according to estimation, the
    size of the batches is not guaranteed to be less than the limit, especially when a single row
    is larger than the limit, in which case the server will fail to split it further into smaller
    batches. As a result, the client may encounter a gRPC error stating “Received message larger
    than max” when a batch is too large.
    If allow_arrow_batch_chunking=true, the server will split large Arrow batches into smaller chunks,
    and the client is expected to handle the chunked Arrow batches.
    
    If false, the server will not chunk large Arrow batches.
    

    bool allow_arrow_batch_chunking = 1;

    returns

    The allowArrowBatchChunking.

    Definition Classes
    ResultChunkingOptions → ResultChunkingOptionsOrBuilder
    Annotations
    @Override()
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def getDefaultInstanceForType(): ResultChunkingOptions
    Definition Classes
    ResultChunkingOptions → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  13. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  14. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  15. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  16. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  17. def getParserForType(): Parser[ResultChunkingOptions]
    Definition Classes
    ResultChunkingOptions → GeneratedMessage → Message → MessageLite
    Annotations
    @Override()
  18. def getPreferredArrowChunkSize(): Long

    Optional preferred Arrow batch size in bytes for the server to use when sending Arrow results.
    The server will attempt to use this size if it is set and within the valid range
    ([1KB, max batch size on server]). Otherwise, the server's maximum batch size is used.
    

    Optional preferred Arrow batch size in bytes for the server to use when sending Arrow results.
    The server will attempt to use this size if it is set and within the valid range
    ([1KB, max batch size on server]). Otherwise, the server's maximum batch size is used.
    

    optional int64 preferred_arrow_chunk_size = 2;

    returns

    The preferredArrowChunkSize.

    Definition Classes
    ResultChunkingOptions → ResultChunkingOptionsOrBuilder
    Annotations
    @Override()
  19. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  20. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  21. def getSerializedSize(): Int
    Definition Classes
    ResultChunkingOptions → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  22. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  23. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  24. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  25. def hasPreferredArrowChunkSize(): Boolean

    Optional preferred Arrow batch size in bytes for the server to use when sending Arrow results.
    The server will attempt to use this size if it is set and within the valid range
    ([1KB, max batch size on server]). Otherwise, the server's maximum batch size is used.
    

    Optional preferred Arrow batch size in bytes for the server to use when sending Arrow results.
    The server will attempt to use this size if it is set and within the valid range
    ([1KB, max batch size on server]). Otherwise, the server's maximum batch size is used.
    

    optional int64 preferred_arrow_chunk_size = 2;

    returns

    Whether the preferredArrowChunkSize field is set.

    Definition Classes
    ResultChunkingOptions → ResultChunkingOptionsOrBuilder
    Annotations
    @Override()
  26. def hashCode(): Int
    Definition Classes
    ResultChunkingOptions → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  27. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    ResultChunkingOptions → GeneratedMessage
    Annotations
    @Override()
  28. def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  29. final def isInitialized(): Boolean
    Definition Classes
    ResultChunkingOptions → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    ResultChunkingOptions → AbstractMessage
    Annotations
    @Override()
  34. def newBuilderForType(): Builder
    Definition Classes
    ResultChunkingOptions → Message → MessageLite
    Annotations
    @Override()
  35. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  38. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  39. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toBuilder(): Builder
    Definition Classes
    ResultChunkingOptions → Message → MessageLite
    Annotations
    @Override()
  42. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  43. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  44. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  49. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  50. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    ResultChunkingOptions → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  51. 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 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