Package io.deephaven.extensions.barrage

Class BarrageSnapshotOptions

java.lang.Object

io.deephaven.extensions.barrage.BarrageSnapshotOptions

All Implemented Interfaces:

BarrageOptions

@Immutable
public abstract class BarrageSnapshotOptions
extends Object
implements BarrageOptions

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()
int	maxMessageSize()
static BarrageSnapshotOptions	of(io.deephaven.barrage.flatbuf.BarrageSnapshotOptions options)
static BarrageSnapshotOptions	of(io.deephaven.barrage.flatbuf.BarrageSnapshotRequest snapshotRequest)
long	previewListLengthLimit()	The maximum length of any list / array to encode.
boolean	useDeephavenNulls()

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.BarrageOptions

columnConversionMode, 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()

Specified by:

useDeephavenNulls in interface BarrageOptions

Returns:

whether we encode the validity buffer to express null values or QueryConstants' NULL values.

batchSize

@Default
public int batchSize()

Specified by:

batchSize in interface BarrageOptions

Returns:

the ideal number of records to send per record batch

maxMessageSize

@Default
public int maxMessageSize()

Specified by:

maxMessageSize in interface BarrageOptions

Returns:

the maximum number of bytes that should be sent in a single message.

previewListLengthLimit

@Default
public long previewListLengthLimit()

Description copied from interface: BarrageOptions

The maximum length of any list / array to encode.

• If zero, list lengths will not be limited.
• If non-zero, the server will limit the length of any encoded list / array to the absolute value of the returned length.
• If less than zero, the server will encode elements from the end of the list / array, rather than rom the beginning.

Note: The server is unable to indicate when truncation occurs. To detect truncation request one more element than the maximum number you wish to display.

Specified by:

previewListLengthLimit in interface BarrageOptions

Returns:

the maximum length of any list / array to encode; zero means no limit; negative values indicate to treat the limit as a tail instead of a head

appendTo

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