io.deephaven.barrage.flatbuf

Class BarrageSnapshotOptions

java.lang.Object

com.google.flatbuffers.Table

io.deephaven.barrage.flatbuf.BarrageSnapshotOptions

public final class BarrageSnapshotOptions
extends com.google.flatbuffers.Table

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BarrageSnapshotOptions.Vector

Field Summary

Fields inherited from class com.google.flatbuffers.Table

bb, bb_pos

Constructor Summary

Constructors

Constructor and Description
BarrageSnapshotOptions()

Method Summary

Modifier and Type	Method and Description
BarrageSnapshotOptions	__assign(int _i, ByteBuffer _bb)
void	__init(int _i, ByteBuffer _bb)
static void	addBatchSize(com.google.flatbuffers.FlatBufferBuilder builder, int batchSize)
static void	addColumnConversionMode(com.google.flatbuffers.FlatBufferBuilder builder, byte columnConversionMode)
static void	addMaxMessageSize(com.google.flatbuffers.FlatBufferBuilder builder, int maxMessageSize)
static void	addUseDeephavenNulls(com.google.flatbuffers.FlatBufferBuilder builder, boolean useDeephavenNulls)
int	batchSize() Specify a preferred batch size.
byte	columnConversionMode() see enum for details
static int	createBarrageSnapshotOptions(com.google.flatbuffers.FlatBufferBuilder builder, byte column_conversion_mode, boolean use_deephaven_nulls, int batch_size, int max_message_size)
static int	endBarrageSnapshotOptions(com.google.flatbuffers.FlatBufferBuilder builder)
static BarrageSnapshotOptions	getRootAsBarrageSnapshotOptions(ByteBuffer _bb)
static BarrageSnapshotOptions	getRootAsBarrageSnapshotOptions(ByteBuffer _bb, BarrageSnapshotOptions obj)
int	maxMessageSize() Specify a maximum allowed message size.
static void	startBarrageSnapshotOptions(com.google.flatbuffers.FlatBufferBuilder builder)
boolean	useDeephavenNulls() Deephaven reserves a value in the range of primitives as a custom NULL value.
static void	ValidateVersion()

Methods inherited from class com.google.flatbuffers.Table

__has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, __vector, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BarrageSnapshotOptions

public BarrageSnapshotOptions()

Method Detail

ValidateVersion

public static void ValidateVersion()

getRootAsBarrageSnapshotOptions

public static BarrageSnapshotOptions getRootAsBarrageSnapshotOptions(ByteBuffer _bb)

getRootAsBarrageSnapshotOptions

public static BarrageSnapshotOptions getRootAsBarrageSnapshotOptions(ByteBuffer _bb,
                                                                     BarrageSnapshotOptions obj)

__init

public void __init(int _i,
                   ByteBuffer _bb)

__assign

public BarrageSnapshotOptions __assign(int _i,
                                       ByteBuffer _bb)

columnConversionMode

public byte columnConversionMode()

see enum for details

useDeephavenNulls

public boolean useDeephavenNulls()

Deephaven reserves a value in the range of primitives as a custom NULL value. This enables more efficient transmission by eliminating the additional complexity of the validity buffer.

batchSize

public int batchSize()

Specify a preferred batch size. Server is allowed to be configured to restrict possible values. Too small of a batch size may be dominated with header costs as each batch is wrapped into a separate RecordBatch. Too large of a payload and it may not fit within the maximum payload size. A good default might be 4096.

maxMessageSize

public int maxMessageSize()

Specify a maximum allowed message size. Server will enforce this limit by reducing batch size (to a lower limit of one row per batch). If the message size limit cannot be met due to large row sizes, the server will throw a `Status.RESOURCE_EXHAUSTED` exception

createBarrageSnapshotOptions

public static int createBarrageSnapshotOptions(com.google.flatbuffers.FlatBufferBuilder builder,
                                               byte column_conversion_mode,
                                               boolean use_deephaven_nulls,
                                               int batch_size,
                                               int max_message_size)

startBarrageSnapshotOptions

public static void startBarrageSnapshotOptions(com.google.flatbuffers.FlatBufferBuilder builder)

addColumnConversionMode

public static void addColumnConversionMode(com.google.flatbuffers.FlatBufferBuilder builder,
                                           byte columnConversionMode)

addUseDeephavenNulls

public static void addUseDeephavenNulls(com.google.flatbuffers.FlatBufferBuilder builder,
                                        boolean useDeephavenNulls)

addBatchSize

public static void addBatchSize(com.google.flatbuffers.FlatBufferBuilder builder,
                                int batchSize)

addMaxMessageSize

public static void addMaxMessageSize(com.google.flatbuffers.FlatBufferBuilder builder,
                                     int maxMessageSize)

endBarrageSnapshotOptions

public static int endBarrageSnapshotOptions(com.google.flatbuffers.FlatBufferBuilder builder)