blob: 9d3cbe7682279daa86c40a65352d07436490cf13 [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>
<!-- GitHub action javadoc-cleanup -->
<link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/io/json/JsonIO.Write.html">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- End javadoc-cleanup block -->
<!-- Generated by javadoc -->
<title>JsonIO.Write (Apache Beam 2.55.1)</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="JsonIO.Write (Apache Beam 2.55.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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 class="navBarCell1Rev">Class</li>
<li><a href="package-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><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.html" title="class in org.apache.beam.sdk.io.json"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/json/JsonIO.Write.html" target="_top">Frames</a></li>
<li><a href="JsonIO.Write.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.io.json</div>
<h2 title="Class JsonIO.Write" class="title">Class JsonIO.Write&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;T&gt;,<a href="../../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a>&lt;java.lang.String&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.json.JsonIO.Write&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.html" title="class in org.apache.beam.sdk.io.json">JsonIO</a></dd>
</dl>
<hr>
<br>
<pre>public abstract static class <span class="typeNameLabel">JsonIO.Write&lt;T&gt;</span>
extends <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;T&gt;,<a href="../../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a>&lt;java.lang.String&gt;&gt;</pre>
<div class="block"><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for writing JSON files.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.io.json.JsonIO.Write">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#annotations">annotations</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#displayData">displayData</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#resourceHints">resourceHints</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#Write--">Write</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a>&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#expand-org.apache.beam.sdk.values.PCollection-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;input)</code>
<div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given
<code>InputT</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withCompression-org.apache.beam.sdk.io.Compression-">withCompression</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io">Compression</a>&nbsp;compression)</code>
<div class="block">Specifies the <a href="../../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a> of all generated shard files.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withNoSpilling--">withNoSpilling</a></span>()</code>
<div class="block">Whether to skip the spilling of data.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withNumShards-java.lang.Integer-">withNumShards</a></span>(java.lang.Integer&nbsp;numShards)</code>
<div class="block">Specifies to use a given fixed number of shards per window.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withoutSharding--">withoutSharding</a></span>()</code>
<div class="block">Forces a single file as output and empty shard name template.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withShardTemplate-java.lang.String-">withShardTemplate</a></span>(java.lang.String&nbsp;shardTemplate)</code>
<div class="block">Uses the given <a href="../../../../../../org/apache/beam/sdk/io/ShardNameTemplate.html" title="class in org.apache.beam.sdk.io"><code>ShardNameTemplate</code></a> for naming output files.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withSuffix-java.lang.String-">withSuffix</a></span>(java.lang.String&nbsp;suffix)</code>
<div class="block">Configures the filename suffix for written files.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withTempDirectory-org.apache.beam.sdk.io.fs.ResourceId-">withTempDirectory</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>&nbsp;tempDirectory)</code>
<div class="block">Set the base directory used to generate temporary files.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withWindowedWrites--">withWindowedWrites</a></span>()</code>
<div class="block">Preserves windowing of input elements and writes them to files based on the element's window.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html#withWritableByteChannelFactory-org.apache.beam.sdk.io.FileBasedSink.WritableByteChannelFactory-">withWritableByteChannelFactory</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.WritableByteChannelFactory</a>&nbsp;writableByteChannelFactory)</code>
<div class="block">Returns a transform for writing to text files like this one but that has the given <code>FileBasedSink.WritableByteChannelFactory</code> to be used by the <a href="../../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a> during
output.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#addAnnotation-java.lang.String-byte:A-">addAnnotation</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAdditionalInputs--">getAdditionalInputs</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAnnotations--">getAnnotations</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.PCollection-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getResourceHints--">getResourceHints</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#setDisplayData-java.util.List-">setDisplayData</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#setResourceHints-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">setResourceHints</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-">validate</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-java.util.Map-java.util.Map-">validate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Write--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;Write()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="withCompression-org.apache.beam.sdk.io.Compression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCompression</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withCompression(<a href="../../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io">Compression</a>&nbsp;compression)</pre>
<div class="block">Specifies the <a href="../../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a> of all generated shard files.</div>
</li>
</ul>
<a name="withNoSpilling--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withNoSpilling</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withNoSpilling()</pre>
<div class="block">Whether to skip the spilling of data. See <a href="../../../../../../org/apache/beam/sdk/io/WriteFiles.html#withNoSpilling--"><code>WriteFiles.withNoSpilling()</code></a>.</div>
</li>
</ul>
<a name="withNumShards-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withNumShards</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withNumShards(java.lang.Integer&nbsp;numShards)</pre>
<div class="block">Specifies to use a given fixed number of shards per window. See <code>TextIO.Write#withNumShards</code>.</div>
</li>
</ul>
<a name="withoutSharding--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withoutSharding</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withoutSharding()</pre>
<div class="block">Forces a single file as output and empty shard name template. See <code>TextIO.Write#withoutSharding</code>.</div>
</li>
</ul>
<a name="withShardTemplate-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withShardTemplate</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withShardTemplate(java.lang.String&nbsp;shardTemplate)</pre>
<div class="block">Uses the given <a href="../../../../../../org/apache/beam/sdk/io/ShardNameTemplate.html" title="class in org.apache.beam.sdk.io"><code>ShardNameTemplate</code></a> for naming output files. See <code>TextIO.Write#withShardNameTemplate</code>.</div>
</li>
</ul>
<a name="withSuffix-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSuffix</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withSuffix(java.lang.String&nbsp;suffix)</pre>
<div class="block">Configures the filename suffix for written files. See <code>TextIO.Write#withSuffix</code>.</div>
</li>
</ul>
<a name="withTempDirectory-org.apache.beam.sdk.io.fs.ResourceId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTempDirectory</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withTempDirectory(<a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>&nbsp;tempDirectory)</pre>
<div class="block">Set the base directory used to generate temporary files. See <code>TextIO.Write#withTempDirectory</code>.</div>
</li>
</ul>
<a name="withWindowedWrites--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindowedWrites</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withWindowedWrites()</pre>
<div class="block">Preserves windowing of input elements and writes them to files based on the element's window.
See <code>TextIO.Write#withWindowedWrites</code>.</div>
</li>
</ul>
<a name="withWritableByteChannelFactory-org.apache.beam.sdk.io.FileBasedSink.WritableByteChannelFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWritableByteChannelFactory</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="class in org.apache.beam.sdk.io.json">JsonIO.Write</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;withWritableByteChannelFactory(<a href="../../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.WritableByteChannelFactory</a>&nbsp;writableByteChannelFactory)</pre>
<div class="block">Returns a transform for writing to text files like this one but that has the given <code>FileBasedSink.WritableByteChannelFactory</code> to be used by the <a href="../../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a> during
output. See <code>TextIO.Write#withWritableByteChannelFactory</code>.</div>
</li>
</ul>
<a name="expand-org.apache.beam.sdk.values.PCollection-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>expand</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a>&lt;java.lang.String&gt;&nbsp;expand(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;&nbsp;input)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div>
<div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given
<code>InputT</code>.
<p>NOTE: This method should not be called directly. Instead apply the <code>PTransform</code> should
be applied to the <code>InputT</code> using the <code>apply</code> method.
<p>Composite transforms, which are defined in terms of other transforms, should return the
output of one of the composed transforms. Non-composite transforms, which do not apply any
transforms internally, should return a new unbound output and register evaluators (via
backend-specific registration methods).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.Write.html" title="type parameter in JsonIO.Write">T</a>&gt;,<a href="../../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a>&lt;java.lang.String&gt;&gt;</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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 class="navBarCell1Rev">Class</li>
<li><a href="package-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><a href="../../../../../../org/apache/beam/sdk/io/json/JsonIO.html" title="class in org.apache.beam.sdk.io.json"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/json/JsonIO.Write.html" target="_top">Frames</a></li>
<li><a href="JsonIO.Write.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>