javadoc/2.15.0/org/apache/beam/sdk/io/DefaultFilenamePolicy.html - beam-site - Git at Google

 <!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 (1.8.0_181-google-v7) on Wed Aug 14 17:37:14 PDT 2019 -->
 <title>DefaultFilenamePolicy (Apache Beam 2.15.0-SNAPSHOT)</title>
 <meta name="date" content="2019-08-14">
 <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="DefaultFilenamePolicy (Apache Beam 2.15.0-SNAPSHOT)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/CountingSource.CounterMark.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/beam/sdk/io/DefaultFilenamePolicy.html" target="_top">Frames</a></li>
 <li><a href="DefaultFilenamePolicy.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&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</div>
 <h2 title="Class DefaultFilenamePolicy" class="title">Class DefaultFilenamePolicy</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.FileBasedSink.FilenamePolicy</a></li>
 <li>
 <ul class="inheritance">
 <li>org.apache.beam.sdk.io.DefaultFilenamePolicy</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</dd>
 </dl>
 <hr>
 <br>
 <pre>public final class <span class="typeNameLabel">DefaultFilenamePolicy</span>
 extends <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a></pre>
 <div class="block">A default <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a> for windowed and unwindowed files. This policy is constructed
  using three parameters that together define the output name of a sharded file, in conjunction
  with the number of shards, index of the particular file, current window and pane information,
  using <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#constructName-org.apache.beam.sdk.io.fs.ResourceId-java.lang.String-java.lang.String-int-int-java.lang.String-java.lang.String-"><code>constructName(org.apache.beam.sdk.io.fs.ResourceId, java.lang.String, java.lang.String, int, int, java.lang.String, java.lang.String)</code></a>.

  <p>Most users will use this <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a>. For more advanced uses in generating
  different files for each window and other sharding controls, see the <code>WriteOneFilePerWindow</code> example pipeline.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.io.DefaultFilenamePolicy">Serialized Form</a></dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
 <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Class and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a></span></code>
 <div class="block">Encapsulates constructor parameters to <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.ParamsCoder.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.ParamsCoder</a></span></code>
 <div class="block">A Coder for <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy.Params</code></a>.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- =========== FIELD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</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>
 <tr class="altColor">
 <td class="colFirst"><code>static java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#DEFAULT_UNWINDOWED_SHARD_TEMPLATE">DEFAULT_UNWINDOWED_SHARD_TEMPLATE</a></span></code>
 <div class="block">The default sharding name template.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#DEFAULT_WINDOWED_SHARD_TEMPLATE">DEFAULT_WINDOWED_SHARD_TEMPLATE</a></span></code>
 <div class="block">The default windowed sharding name template used when writing windowed files.</div>
 </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#fromParams-org.apache.beam.sdk.io.DefaultFilenamePolicy.Params-">fromParams</a></span>(<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a>&nbsp;params)</code>
 <div class="block">Construct a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a> from a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy.Params</code></a> object.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#fromStandardParameters-org.apache.beam.sdk.options.ValueProvider-java.lang.String-java.lang.String-boolean-">fromStandardParameters</a></span>(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a>&lt;<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>&gt;&nbsp;baseFilename,
                       java.lang.String&nbsp;shardTemplate,
                       java.lang.String&nbsp;filenameSuffix,
                       boolean&nbsp;windowedWrites)</code>
 <div class="block">Construct a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a>.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</code>
 <div class="block">Populates the display data.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#unwindowedFilename-int-int-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">unwindowedFilename</a></span>(int&nbsp;shardNumber,
                   int&nbsp;numShards,
                   <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.OutputFileHints</a>&nbsp;outputFileHints)</code>
 <div class="block">When a sink has not requested windowed or triggered output, this method will be invoked to
  return the file <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>resource</code></a> to be created given the base output directory and
  a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io"><code>FileBasedSink.OutputFileHints</code></a> containing information about the file, including a suggested (e.g.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html#windowedFilename-int-int-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.apache.beam.sdk.transforms.windowing.PaneInfo-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">windowedFilename</a></span>(int&nbsp;shardNumber,
                 int&nbsp;numShards,
                 <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&nbsp;window,
                 <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a>&nbsp;paneInfo,
                 <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.OutputFileHints</a>&nbsp;outputFileHints)</code>
 <div class="block">When a sink has requested windowed or triggered output, this method will be invoked to return
  the file <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>resource</code></a> to be created given the base output directory and a
  <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io"><code>FileBasedSink.OutputFileHints</code></a> containing information about the file, including a suggested
  extension (e.g.</div>
 </td>
 </tr>
 </table>
 <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, toString, wait, wait, wait</code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="DEFAULT_UNWINDOWED_SHARD_TEMPLATE">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>DEFAULT_UNWINDOWED_SHARD_TEMPLATE</h4>
 <pre>public static final&nbsp;java.lang.String DEFAULT_UNWINDOWED_SHARD_TEMPLATE</pre>
 <div class="block">The default sharding name template.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../constant-values.html#org.apache.beam.sdk.io.DefaultFilenamePolicy.DEFAULT_UNWINDOWED_SHARD_TEMPLATE">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="DEFAULT_WINDOWED_SHARD_TEMPLATE">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>DEFAULT_WINDOWED_SHARD_TEMPLATE</h4>
 <pre>public static final&nbsp;java.lang.String DEFAULT_WINDOWED_SHARD_TEMPLATE</pre>
 <div class="block">The default windowed sharding name template used when writing windowed files. This is used as
  default in cases when user did not specify shard template to be used and there is a need to
  write windowed files. In cases when user does specify shard template to be used then provided
  template will be used for both windowed and non-windowed file names.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../constant-values.html#org.apache.beam.sdk.io.DefaultFilenamePolicy.DEFAULT_WINDOWED_SHARD_TEMPLATE">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="fromStandardParameters-org.apache.beam.sdk.options.ValueProvider-java.lang.String-java.lang.String-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>fromStandardParameters</h4>
 <pre>public static&nbsp;<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy</a>&nbsp;fromStandardParameters(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a>&lt;<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>&gt;&nbsp;baseFilename,
                                                            @Nullable
                                                            java.lang.String&nbsp;shardTemplate,
                                                            @Nullable
                                                            java.lang.String&nbsp;filenameSuffix,
                                                            boolean&nbsp;windowedWrites)</pre>
 <div class="block">Construct a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a>.

  <p>This is a shortcut for:

  <pre><code>
  DefaultFilenamePolicy.fromParams(new Params()
    .withBaseFilename(baseFilename)
    .withShardTemplate(shardTemplate)
    .withSuffix(filenameSuffix)
    .withWindowedWrites())
  </code></pre>

  <p>Where the respective <code>with</code> methods are invoked only if the value is non-null or true.</div>
 </li>
 </ul>
 <a name="fromParams-org.apache.beam.sdk.io.DefaultFilenamePolicy.Params-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>fromParams</h4>
 <pre>public static&nbsp;<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy</a>&nbsp;fromParams(<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a>&nbsp;params)</pre>
 <div class="block">Construct a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a> from a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy.Params</code></a> object.</div>
 </li>
 </ul>
 <a name="unwindowedFilename-int-int-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>unwindowedFilename</h4>
 <pre>@Nullable
 public&nbsp;<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>&nbsp;unwindowedFilename(int&nbsp;shardNumber,
                                                int&nbsp;numShards,
                                                <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.OutputFileHints</a>&nbsp;outputFileHints)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#unwindowedFilename-int-int-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">FileBasedSink.FilenamePolicy</a></code></span></div>
 <div class="block">When a sink has not requested windowed or triggered output, this method will be invoked to
  return the file <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>resource</code></a> to be created given the base output directory and
  a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io"><code>FileBasedSink.OutputFileHints</code></a> containing information about the file, including a suggested (e.g.
  coming from <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>).

  <p>The shardNumber and numShards parameters, should be used by the policy to generate unique
  and consistent filenames.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#unwindowedFilename-int-int-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">unwindowedFilename</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="windowedFilename-int-int-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.apache.beam.sdk.transforms.windowing.PaneInfo-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>windowedFilename</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>&nbsp;windowedFilename(int&nbsp;shardNumber,
                                    int&nbsp;numShards,
                                    <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&nbsp;window,
                                    <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a>&nbsp;paneInfo,
                                    <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.OutputFileHints</a>&nbsp;outputFileHints)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#windowedFilename-int-int-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.apache.beam.sdk.transforms.windowing.PaneInfo-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">FileBasedSink.FilenamePolicy</a></code></span></div>
 <div class="block">When a sink has requested windowed or triggered output, this method will be invoked to return
  the file <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>resource</code></a> to be created given the base output directory and a
  <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io"><code>FileBasedSink.OutputFileHints</code></a> containing information about the file, including a suggested
  extension (e.g. coming from <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>).

  <p>The policy must return unique and consistent filenames for different windows and panes.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#windowedFilename-int-int-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.apache.beam.sdk.transforms.windowing.PaneInfo-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-">windowedFilename</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>populateDisplayData</h4>
 <pre>public&nbsp;void&nbsp;populateDisplayData(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">FileBasedSink.FilenamePolicy</a></code></span></div>
 <div class="block">Populates the display data.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a></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/CountingSource.CounterMark.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/beam/sdk/io/DefaultFilenamePolicy.html" target="_top">Frames</a></li>
 <li><a href="DefaultFilenamePolicy.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&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>