trait ResultChunkingOptionsOrBuilder extends MessageOrBuilder
- Annotations
- @Generated()
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- ResultChunkingOptionsOrBuilder
- MessageOrBuilder
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Abstract Value Members
- abstract def findInitializationErrors(): List[String]
- Definition Classes
- MessageOrBuilder
- abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- MessageOrBuilder
- abstract 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.
- abstract def getDefaultInstanceForType(): Message
- Definition Classes
- MessageOrBuilder → MessageLiteOrBuilder
- abstract def getDescriptorForType(): Descriptor
- Definition Classes
- MessageOrBuilder
- abstract def getField(field: FieldDescriptor): AnyRef
- Definition Classes
- MessageOrBuilder
- abstract def getInitializationErrorString(): String
- Definition Classes
- MessageOrBuilder
- abstract def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
- Definition Classes
- MessageOrBuilder
- abstract 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.
- abstract def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
- Definition Classes
- MessageOrBuilder
- abstract def getRepeatedFieldCount(field: FieldDescriptor): Int
- Definition Classes
- MessageOrBuilder
- abstract def getUnknownFields(): UnknownFieldSet
- Definition Classes
- MessageOrBuilder
- abstract def hasField(field: FieldDescriptor): Boolean
- Definition Classes
- MessageOrBuilder
- abstract def hasOneof(oneof: OneofDescriptor): Boolean
- Definition Classes
- MessageOrBuilder
- abstract 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.
- abstract def isInitialized(): Boolean
- Definition Classes
- MessageLiteOrBuilder
Concrete 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(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)