Package io.deephaven.extensions.barrage

Interface BarrageSnapshotOptions.Builder

Enclosing class:

BarrageSnapshotOptions

public static interface BarrageSnapshotOptions.Builder

Method Summary

Modifier and Type	Method	Description
BarrageSnapshotOptions.Builder	batchSize(int batchSize)	See StreamReaderOptions.batchSize() for details.
BarrageSnapshotOptions	build()
default BarrageSnapshotOptions.Builder	columnConversionMode(ColumnConversionMode columnConversionMode)	Deprecated. Since 0.37.0 and is marked for removal.
BarrageSnapshotOptions.Builder	maxMessageSize(int messageSize)	See StreamReaderOptions.maxMessageSize() for details.
BarrageSnapshotOptions.Builder	previewListLengthLimit(long previewListLengthLimit)	See StreamReaderOptions.previewListLengthLimit() for details.
BarrageSnapshotOptions.Builder	useDeephavenNulls(boolean useDeephavenNulls)	See StreamReaderOptions.useDeephavenNulls() for details.

Method Details

useDeephavenNulls

BarrageSnapshotOptions.Builder useDeephavenNulls(boolean useDeephavenNulls)

See StreamReaderOptions.useDeephavenNulls() for details.

Parameters:

useDeephavenNulls - whether to use deephaven nulls

Returns:

this builder

columnConversionMode

@FinalDefault
@Deprecated
default BarrageSnapshotOptions.Builder columnConversionMode(ColumnConversionMode columnConversionMode)

Deprecated.

Since 0.37.0 and is marked for removal. (Note, GWT does not support encoding this context via annotation values.)

The default conversion mode is to Stringify all objects that do not have a registered encoding. Column conversion modes are no longer supported.

batchSize

BarrageSnapshotOptions.Builder batchSize(int batchSize)

See StreamReaderOptions.batchSize() for details.

Parameters:

batchSize - the ideal number of records to send per record batch

Returns:

this builder

maxMessageSize

BarrageSnapshotOptions.Builder maxMessageSize(int messageSize)

See StreamReaderOptions.maxMessageSize() for details.

Parameters:

messageSize - the maximum size of a GRPC message in bytes

Returns:

this builder

previewListLengthLimit

BarrageSnapshotOptions.Builder previewListLengthLimit(long previewListLengthLimit)

See StreamReaderOptions.previewListLengthLimit() for details.

Parameters:

previewListLengthLimit - the magnitude of the number of elements to include in a preview list

Returns:

this builder

build

BarrageSnapshotOptions build()

Returns:

a new BarrageSnapshotOptions instance