final class ResultChunkingOptions extends GeneratedMessage with ResultChunkingOptionsOrBuilder
Protobuf type spark.connect.ResultChunkingOptions
- Annotations
- @Generated()
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ResultChunkingOptions
- ResultChunkingOptionsOrBuilder
- GeneratedMessage
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: AnyRef): Boolean
- Definition Classes
- ResultChunkingOptions → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- 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()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getDefaultInstanceForType(): ResultChunkingOptions
- Definition Classes
- ResultChunkingOptions → MessageOrBuilder → MessageLiteOrBuilder
- Annotations
- @Override()
- def getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- def getField(field: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- def getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessage → AbstractMessage → MessageOrBuilder
- def getParserForType(): Parser[ResultChunkingOptions]
- Definition Classes
- ResultChunkingOptions → GeneratedMessage → Message → MessageLite
- Annotations
- @Override()
- 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()
- def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- def getRepeatedFieldCount(field: FieldDescriptor): Int
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- def getSerializedSize(): Int
- Definition Classes
- ResultChunkingOptions → GeneratedMessage → AbstractMessage → MessageLite
- Annotations
- @Override()
- def getUnknownFields(): UnknownFieldSet
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- def hasField(field: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessage → MessageOrBuilder
- def hasOneof(oneof: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessage → AbstractMessage → MessageOrBuilder
- 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()
- def hashCode(): Int
- Definition Classes
- ResultChunkingOptions → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[proto]
- Definition Classes
- ResultChunkingOptions → GeneratedMessage
- Annotations
- @Override()
- def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- final def isInitialized(): Boolean
- Definition Classes
- ResultChunkingOptions → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[proto]
- Definition Classes
- ResultChunkingOptions → AbstractMessage
- Annotations
- @Override()
- def newBuilderForType(): Builder
- Definition Classes
- ResultChunkingOptions → Message → MessageLite
- Annotations
- @Override()
- def newInstance(unused: UnusedPrivateParameter): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- Annotations
- @throws(classOf[java.io.IOException])
- def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- Annotations
- @throws(classOf[java.io.IOException])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBuilder(): Builder
- Definition Classes
- ResultChunkingOptions → Message → MessageLite
- Annotations
- @Override()
- def toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
- def toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
- final def toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
- def writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- Annotations
- @throws(classOf[java.io.ObjectStreamException])
- def writeTo(output: CodedOutputStream): Unit
- Definition Classes
- ResultChunkingOptions → GeneratedMessage → AbstractMessage → MessageLite
- Annotations
- @Override()
- def writeTo(output: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def internalGetMapField(fieldNumber: Int): MapField[_ <: AnyRef, _ <: AnyRef]
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- Annotations
- @Deprecated
- Deprecated
- def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessage
- Annotations
- @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
- Deprecated