blob: 55a13a397ebe1314114ecbd952a6dbcc58c736ed [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.apache.arrow.vector.ipc.message.IpcOption (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class org.apache.arrow.vector.ipc.message.IpcOption (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../../../../../../../overview-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/arrow/vector/ipc/message/class-use/IpcOption.html" target="_top">Frames</a></li>
<li><a href="IpcOption.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.arrow.vector.ipc.message.IpcOption" class="title">Uses of Class<br>org.apache.arrow.vector.ipc.message.IpcOption</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.arrow.flight">org.apache.arrow.flight</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.arrow.vector.ipc">org.apache.arrow.vector.ipc</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.arrow.vector.ipc.message">org.apache.arrow.vector.ipc.message</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.arrow.flight">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> in <a href="../../../../../../../org/apache/arrow/flight/package-summary.html">org.apache.arrow.flight</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../org/apache/arrow/flight/package-summary.html">org.apache.arrow.flight</a> with parameters of type <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/arrow/flight/FlightInfo.Builder.html" title="class in org.apache.arrow.flight">FlightInfo.Builder</a></code></td>
<td class="colLast"><span class="typeNameLabel">FlightInfo.Builder.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/flight/FlightInfo.Builder.html#setOption-org.apache.arrow.vector.ipc.message.IpcOption-">setOption</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Set IPC write options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">OutboundStreamListener.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/flight/OutboundStreamListener.html#start-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-org.apache.arrow.vector.ipc.message.IpcOption-">start</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;dictionaries,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Start sending data, using the schema of the given <a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector"><code>VectorSchemaRoot</code></a>.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
<caption><span>Constructors in <a href="../../../../../../../org/apache/arrow/flight/package-summary.html">org.apache.arrow.flight</a> with parameters of type <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/flight/FlightInfo.html#FlightInfo-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.flight.FlightDescriptor-java.util.List-long-long-boolean-org.apache.arrow.vector.ipc.message.IpcOption-">FlightInfo</a></span>(<a href="../../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a>&nbsp;descriptor,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a>&gt;&nbsp;endpoints,
long&nbsp;bytes,
long&nbsp;records,
boolean&nbsp;ordered,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Constructs a new instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/flight/FlightInfo.html#FlightInfo-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.flight.FlightDescriptor-java.util.List-long-long-boolean-org.apache.arrow.vector.ipc.message.IpcOption-byte:A-">FlightInfo</a></span>(<a href="../../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a>&nbsp;descriptor,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a>&gt;&nbsp;endpoints,
long&nbsp;bytes,
long&nbsp;records,
boolean&nbsp;ordered,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option,
byte[]&nbsp;appMetadata)</code>
<div class="block">Constructs a new instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/flight/FlightInfo.html#FlightInfo-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.flight.FlightDescriptor-java.util.List-long-long-org.apache.arrow.vector.ipc.message.IpcOption-">FlightInfo</a></span>(<a href="../../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a>&nbsp;descriptor,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a>&gt;&nbsp;endpoints,
long&nbsp;bytes,
long&nbsp;records,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Constructs a new instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/flight/SchemaResult.html#SchemaResult-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">SchemaResult</a></span>(<a href="../../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Create a schema result with specific IPC options for serialization.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.arrow.vector.ipc">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> in <a href="../../../../../../../org/apache/arrow/vector/ipc/package-summary.html">org.apache.arrow.vector.ipc</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
<caption><span>Fields in <a href="../../../../../../../org/apache/arrow/vector/ipc/package-summary.html">org.apache.arrow.vector.ipc</a> declared as <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></code></td>
<td class="colLast"><span class="typeNameLabel">ArrowWriter.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#option">option</a></span></code>&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../org/apache/arrow/vector/ipc/package-summary.html">org.apache.arrow.vector.ipc</a> with parameters of type <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">ArrowStreamWriter.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#writeEndOfStream-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.IpcOption-">writeEndOfStream</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Write an EOS identifier to the WriteChannel.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
<caption><span>Constructors in <a href="../../../../../../../org/apache/arrow/vector/ipc/package-summary.html">org.apache.arrow.vector.ipc</a> with parameters of type <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowFileWriter.html#ArrowFileWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-">ArrowFileWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowFileWriter.html#ArrowFileWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-java.util.Map-org.apache.arrow.vector.ipc.message.IpcOption-">ArrowFileWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;metaData,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowFileWriter.html#ArrowFileWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-java.util.Map-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-">ArrowFileWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;metaData,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a>&nbsp;compressionFactory,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a>&nbsp;codecType)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowFileWriter.html#ArrowFileWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-java.util.Map-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-java.util.Optional-">ArrowFileWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;metaData,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a>&nbsp;compressionFactory,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a>&nbsp;codecType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;compressionLevel)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-">ArrowStreamWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-">ArrowStreamWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a>&nbsp;compressionFactory,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a>&nbsp;codecType)</code>
<div class="block">Construct an ArrowStreamWriter with compression enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-java.util.Optional-">ArrowStreamWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a>&nbsp;compressionFactory,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a>&nbsp;codecType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;compressionLevel)</code>
<div class="block">Construct an ArrowStreamWriter with compression enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#ArrowWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-">ArrowWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#ArrowWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-java.util.Optional-">ArrowWriter</a></span>(<a href="../../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a>&nbsp;compressionFactory,
<a href="../../../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a>&nbsp;codecType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;compressionLevel)</code>
<div class="block">Note: fields are not closed when the writer is closed.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.arrow.vector.ipc.message">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> in <a href="../../../../../../../org/apache/arrow/vector/ipc/message/package-summary.html">org.apache.arrow.vector.ipc.message</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
<caption><span>Fields in <a href="../../../../../../../org/apache/arrow/vector/ipc/message/package-summary.html">org.apache.arrow.vector.ipc.message</a> declared as <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></code></td>
<td class="colLast"><span class="typeNameLabel">IpcOption.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html#DEFAULT">DEFAULT</a></span></code>&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../org/apache/arrow/vector/ipc/message/package-summary.html">org.apache.arrow.vector.ipc.message</a> with parameters of type <a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowDictionaryBatch-org.apache.arrow.vector.ipc.message.IpcOption-">serialize</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;batch,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Serializes a dictionary ArrowRecordBatch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-org.apache.arrow.vector.ipc.message.IpcOption-">serialize</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Serializes an ArrowRecordBatch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">serialize</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Serialize a schema object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMessage-com.google.flatbuffers.FlatBufferBuilder-byte-int-long-org.apache.arrow.vector.ipc.message.IpcOption-">serializeMessage</a></span>(com.google.flatbuffers.FlatBufferBuilder&nbsp;builder,
byte&nbsp;headerType,
int&nbsp;headerOffset,
long&nbsp;bodyLength,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</code>
<div class="block">Serializes a message header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMetadata-org.apache.arrow.vector.ipc.message.ArrowMessage-org.apache.arrow.vector.ipc.message.IpcOption-">serializeMetadata</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;message,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</code>
<div class="block">Returns the serialized form of <a href="../../../../../../../org/apache/arrow/flatbuf/RecordBatch.html" title="class in org.apache.arrow.flatbuf"><code>RecordBatch</code></a> wrapped in a <a href="../../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf"><code>Message</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMetadata-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">serializeMetadata</a></span>(<a href="../../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</code>
<div class="block">Returns the serialized flatbuffer bytes of the schema wrapped in a message table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><span class="typeNameLabel">MessageSerializer.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#writeMessageBuffer-org.apache.arrow.vector.ipc.WriteChannel-int-java.nio.ByteBuffer-org.apache.arrow.vector.ipc.message.IpcOption-">writeMessageBuffer</a></span>(<a href="../../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
int&nbsp;messageLength,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;messageBuffer,
<a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Write the serialized Message metadata, prefixed by the length, to the output Channel.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../../../../../../../overview-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/arrow/vector/ipc/message/class-use/IpcOption.html" target="_top">Frames</a></li>
<li><a href="IpcOption.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>