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()
IpcWriteOptions	alignment(int setter)
boolean	allow_64bit()
IpcWriteOptions	allow_64bit(boolean setter)
int	compression_level()
IpcWriteOptions	compression_level(int setter)
Compression.type	compression() \brief Compression codec to use for record batch body buffers May only be UNCOMPRESSED, LZ4_FRAME and ZSTD.
IpcWriteOptions	compression(Compression.type setter)
static IpcWriteOptions	Defaults()
IpcWriteOptions	getPointer(long i)
int	max_recursion_depth()
IpcWriteOptions	max_recursion_depth(int setter)
MemoryPool	memory_pool() \brief The memory pool to use for allocations made during IPC writing
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 encapsulated IPC message format consisting 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(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()

allow_64bit

public IpcWriteOptions allow_64bit(boolean setter)

max_recursion_depth

public int max_recursion_depth()

max_recursion_depth

public IpcWriteOptions max_recursion_depth(int setter)

alignment

public int alignment()

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 encapsulated IPC message format consisting 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

memory_pool

public IpcWriteOptions memory_pool(MemoryPool setter)

compression

public Compression.type compression()

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

compression

public IpcWriteOptions compression(Compression.type setter)

compression_level

public int compression_level()

compression_level

public IpcWriteOptions compression_level(int 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)

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