org.bytedeco.arrow

Class IpcWriteOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.IpcWriteOptions

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::ipc")
 @Properties(inherit=arrow.class)
public class IpcWriteOptions
extends Pointer

\brief Options for writing Arrow IPC messages

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
IpcWriteOptions() Default native constructor.
IpcWriteOptions(long size) Native array allocator.
IpcWriteOptions(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	alignment() \brief Write padding after memory buffers up to this multiple of bytes.
IpcWriteOptions	alignment(int setter)
boolean	allow_64bit() \brief If true, allow field lengths that don't fit in a signed 32-bit int.
IpcWriteOptions	allow_64bit(boolean setter)
Codec	codec() \brief Compression codec to use for record batch body buffers May only be UNCOMPRESSED, LZ4_FRAME and ZSTD.
IpcWriteOptions	codec(Codec setter)
static IpcWriteOptions	Defaults()
boolean	emit_dictionary_deltas() \brief Whether to emit dictionary deltas If false, a changed dictionary for a given field will emit a full dictionary replacement.
IpcWriteOptions	emit_dictionary_deltas(boolean setter)
IpcWriteOptions	getPointer(long i)
int	max_recursion_depth() \brief The maximum permitted schema nesting depth.
IpcWriteOptions	max_recursion_depth(int setter)
MemoryPool	memory_pool() \brief The memory pool to use for allocations made during IPC writing While Arrow IPC is predominantly zero-copy, it may have to allocate memory in some cases (for example if compression is enabled).
IpcWriteOptions	memory_pool(MemoryPool setter)
arrow.MetadataVersion	metadata_version() \brief Format version to use for IPC messages and their metadata.
IpcWriteOptions	metadata_version(arrow.MetadataVersion setter)
IpcWriteOptions	position(long position)
boolean	use_threads() \brief Use global CPU thread pool to parallelize any computational tasks like compression
IpcWriteOptions	use_threads(boolean setter)
boolean	write_legacy_ipc_format() \brief Write the pre-0.15.0 IPC message format This legacy format consists of a 4-byte prefix instead of 8-byte.
IpcWriteOptions	write_legacy_ipc_format(boolean setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IpcWriteOptions

public IpcWriteOptions()

Default native constructor.

IpcWriteOptions

public IpcWriteOptions(long size)

Native array allocator. Access with Pointer.position(long).

IpcWriteOptions

public IpcWriteOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public IpcWriteOptions position(long position)

Overrides:

position in class Pointer

getPointer

public IpcWriteOptions getPointer(long i)

Overrides:

getPointer in class Pointer

allow_64bit

@Cast(value="bool")
public boolean allow_64bit()

\brief If true, allow field lengths that don't fit in a signed 32-bit int. Some implementations may not be able to parse streams created with this option.

allow_64bit

public IpcWriteOptions allow_64bit(boolean setter)

max_recursion_depth

public int max_recursion_depth()

\brief The maximum permitted schema nesting depth.

max_recursion_depth

public IpcWriteOptions max_recursion_depth(int setter)

alignment

public int alignment()

\brief Write padding after memory buffers up to this multiple of bytes.

alignment

public IpcWriteOptions alignment(int setter)

write_legacy_ipc_format

@Cast(value="bool")
public boolean write_legacy_ipc_format()

\brief Write the pre-0.15.0 IPC message format This legacy format consists of a 4-byte prefix instead of 8-byte.

write_legacy_ipc_format

public IpcWriteOptions write_legacy_ipc_format(boolean setter)

memory_pool

public MemoryPool memory_pool()

\brief The memory pool to use for allocations made during IPC writing While Arrow IPC is predominantly zero-copy, it may have to allocate memory in some cases (for example if compression is enabled).

memory_pool

public IpcWriteOptions memory_pool(MemoryPool setter)

codec

@SharedPtr
public Codec codec()

\brief Compression codec to use for record batch body buffers May only be UNCOMPRESSED, LZ4_FRAME and ZSTD.

codec

public IpcWriteOptions codec(Codec setter)

use_threads

@Cast(value="bool")
public boolean use_threads()

\brief Use global CPU thread pool to parallelize any computational tasks like compression

use_threads

public IpcWriteOptions use_threads(boolean setter)

emit_dictionary_deltas

@Cast(value="bool")
public boolean emit_dictionary_deltas()

\brief Whether to emit dictionary deltas If false, a changed dictionary for a given field will emit a full dictionary replacement. If true, a changed dictionary will be compared against the previous version. If possible, a dictionary delta will be omitted, otherwise a full dictionary replacement. Default is false to maximize stream compatibility. Also, note that if a changed dictionary is a nested dictionary, then a delta is never emitted, for compatibility with the read path.

emit_dictionary_deltas

public IpcWriteOptions emit_dictionary_deltas(boolean setter)

metadata_version

public arrow.MetadataVersion metadata_version()

\brief Format version to use for IPC messages and their metadata. Presently using V5 version (readable by 1.0.0 and later). V4 is also available (readable by 0.8.0 and later).

metadata_version

public IpcWriteOptions metadata_version(arrow.MetadataVersion setter)

Defaults

@ByVal
public static IpcWriteOptions Defaults()