Package io.deephaven.extensions.barrage

Class BarrageSnapshotOptions

java.lang.Object

io.deephaven.extensions.barrage.BarrageSnapshotOptions

All Implemented Interfaces:

StreamReaderOptions

@Immutable
public abstract class BarrageSnapshotOptions
extends Object
implements StreamReaderOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BarrageSnapshotOptions.Builder

Constructor Summary

Constructors

Constructor	Description
BarrageSnapshotOptions()

Method Summary

Modifier and Type	Method	Description
int	appendTo(com.google.flatbuffers.FlatBufferBuilder builder)
int	batchSize()
static BarrageSnapshotOptions.Builder	builder()
ColumnConversionMode	columnConversionMode()
int	maxMessageSize()
static BarrageSnapshotOptions	of(io.deephaven.barrage.flatbuf.BarrageSnapshotOptions options)
static BarrageSnapshotOptions	of(io.deephaven.barrage.flatbuf.BarrageSnapshotRequest snapshotRequest)
boolean	useDeephavenNulls()	By default, prefer to communicate null values using the arrow-compatible validity structure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.extensions.barrage.util.StreamReaderOptions

columnsAsList

Constructor Details

BarrageSnapshotOptions

public BarrageSnapshotOptions()

Method Details

builder

public static BarrageSnapshotOptions.Builder builder()

of

public static BarrageSnapshotOptions of(io.deephaven.barrage.flatbuf.BarrageSnapshotOptions options)

of

public static BarrageSnapshotOptions of(io.deephaven.barrage.flatbuf.BarrageSnapshotRequest snapshotRequest)

useDeephavenNulls

@Default
public boolean useDeephavenNulls()

By default, prefer to communicate null values using the arrow-compatible validity structure.

Specified by:

useDeephavenNulls in interface StreamReaderOptions

Returns:

whether to use deephaven nulls

batchSize

@Default
public int batchSize()

Specified by:

batchSize in interface StreamReaderOptions

Returns:

the preferred batch size if specified

maxMessageSize

@Default
public int maxMessageSize()

Specified by:

maxMessageSize in interface StreamReaderOptions

Returns:

the maximum GRPC message size if specified

columnConversionMode

@Default
public ColumnConversionMode columnConversionMode()

Specified by:

columnConversionMode in interface StreamReaderOptions

Returns:

the conversion mode to use for object columns

appendTo

public int appendTo(com.google.flatbuffers.FlatBufferBuilder builder)