Package io.deephaven.extensions.barrage

Interface BarrageSubscriptionOptions.Builder

Enclosing class:

BarrageSubscriptionOptions

public static interface BarrageSubscriptionOptions.Builder

Method Summary

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

Method Details

useDeephavenNulls

BarrageSubscriptionOptions.Builder useDeephavenNulls(boolean useDeephavenNulls)

See StreamReaderOptions.useDeephavenNulls() for details.

Parameters:

useDeephavenNulls - whether to use deephaven nulls

Returns:

this builder

columnsAsList

BarrageSubscriptionOptions.Builder columnsAsList(boolean columnsAsList)

See StreamReaderOptions.columnsAsList() for details.

Parameters:

columnsAsList - whether to wrap columns in a list to be compatible with native Flight clients

Returns:

this builder

columnConversionMode

@FinalDefault
@Deprecated
default BarrageSubscriptionOptions.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.

Returns:

this builder

minUpdateIntervalMs

BarrageSubscriptionOptions.Builder minUpdateIntervalMs(int minUpdateIntervalMs)

See BarrageSubscriptionOptions.minUpdateIntervalMs() for details.

Parameters:

minUpdateIntervalMs - the update interval used to limit barrage message frequency

Returns:

this builder

batchSize

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

BarrageSubscriptionOptions.Builder maxMessageSize(int messageSize)

See StreamReaderOptions.maxMessageSize() for details.

Parameters:

messageSize - the maximum size of a GRPC message in bytes

Returns:

this builder

previewListLengthLimit

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

BarrageSubscriptionOptions build()

Returns:

a new BarrageSubscriptionOptions instance