From e94e15b2bac716bc6b8b1e6b6e72d049f64bfe93 Mon Sep 17 00:00:00 2001
From: Maria Garcia Herrero <mariagh@google.com>
Date: Wed, 28 Dec 2016 23:12:37 -0800
Subject: [PATCH] Rename apache_beam.utils.options to
 apache_beam.utils.pipeline_options

---
 content/documentation/programming-guide/index.html | 12 ++++++------
 content/documentation/runners/dataflow/index.html  |  4 ++--
 content/documentation/runners/direct/index.html    |  4 ++--
 content/documentation/runners/flink/index.html     |  4 ++--
 src/documentation/programming-guide.md             |  4 ++--
 src/documentation/runners/dataflow.md              |  2 +-
 src/documentation/runners/direct.md                |  2 +-
 src/documentation/runners/flink.md                 |  2 +-
 8 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/content/documentation/programming-guide/index.html b/content/documentation/programming-guide/index.html
index 1042062d52c..e88195d9ada 100644
--- a/content/documentation/programming-guide/index.html
+++ b/content/documentation/programming-guide/index.html
@@ -107,7 +107,7 @@
         <li class="dropdown-header">Technical References</li>
         <li><a href="/contribute/design-principles/">Design Principles</a></li>
 			  <li><a href="/contribute/work-in-progress/">Ongoing Projects</a></li>
-        <li><a href="/contribute/source-repository/">Source Repository</a></li>      
+        <li><a href="/contribute/source-repository/">Source Repository</a></li>
         <li role="separator" class="divider"></li>
 			  <li class="dropdown-header">Promotion</li>
         <li><a href="/contribute/presentation-materials/">Presentation Materials</a></li>
@@ -149,7 +149,7 @@ <h1 id="apache-beam-programming-guide">Apache Beam Programming Guide</h1>
 <p>The <strong>Beam Programming Guide</strong> is intended for Beam users who want to use the Beam SDKs to create data processing pipelines. It provides guidance for using the Beam SDK classes to build and test your pipeline. It is not intended as an exhaustive reference, but as a language-agnostic, high-level guide to programmatically building your Beam pipeline. As the programming guide is filled out, the text will include code samples in multiple languages to help illustrate how to implement Beam concepts in your programs.</p>
 
 <nav class="language-switcher">
-  <strong>Adapt for:</strong> 
+  <strong>Adapt for:</strong>
   <ul>
     <li data-type="language-java">Java SDK</li>
     <li data-type="language-py">Python SDK</li>
@@ -233,7 +233,7 @@ <h2 id="a-namepipelineacreating-the-pipeline"><a name="pipeline"></a>Creating th
 
 <p>The pipeline configuration options determine, among other things, the <code class="highlighter-rouge">PipelineRunner</code> that determines where the pipeline gets executed: locally, or using a distributed back-end of your choice. Depending on where your pipeline gets executed and what your specifed Runner requires, the options can also help you specify other aspects of execution.</p>
 
-<p>To set your pipeline’s configuration options and create the pipeline, create an object of type <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/sdk/options/PipelineOptions.html">PipelineOptions</a></span><span class="language-py"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py">PipelineOptions</a></span> and pass it to <code class="highlighter-rouge">Pipeline.Create()</code>. The most common way to do this is by parsing arguments from the command-line:</p>
+<p>To set your pipeline’s configuration options and create the pipeline, create an object of type <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/sdk/options/PipelineOptions.html">PipelineOptions</a></span><span class="language-py"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py">PipelineOptions</a></span> and pass it to <code class="highlighter-rouge">Pipeline.Create()</code>. The most common way to do this is by parsing arguments from the command-line:</p>
 
 <div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span>
    <span class="c1">// Will parse the arguments passed into the application and construct a PipelineOptions</span>
@@ -246,7 +246,7 @@ <h2 id="a-namepipelineacreating-the-pipeline"><a name="pipeline"></a>Creating th
 </code></pre>
 </div>
 
-<div class="language-py highlighter-rouge"><pre class="highlight"><code><span class="kn">from</span> <span class="nn">apache_beam.utils.options</span> <span class="kn">import</span> <span class="n">PipelineOptions</span>
+<div class="language-py highlighter-rouge"><pre class="highlight"><code><span class="kn">from</span> <span class="nn">apache_beam.utils.pipeline_options</span> <span class="kn">import</span> <span class="n">PipelineOptions</span>
 
 <span class="c"># Will parse the arguments passed into the application and construct a PipelineOptions</span>
 <span class="c"># Note that --help will print registered options.</span>
@@ -274,7 +274,7 @@ <h4 id="reading-from-an-external-source">Reading from an External Source</h4>
 
 <div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span>
     <span class="c1">// Create the pipeline.</span>
-    <span class="n">PipelineOptions</span> <span class="n">options</span> <span class="o">=</span> 
+    <span class="n">PipelineOptions</span> <span class="n">options</span> <span class="o">=</span>
         <span class="n">PipelineOptionsFactory</span><span class="o">.</span><span class="na">fromArgs</span><span class="o">(</span><span class="n">args</span><span class="o">).</span><span class="na">create</span><span class="o">();</span>
     <span class="n">Pipeline</span> <span class="n">p</span> <span class="o">=</span> <span class="n">Pipeline</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">options</span><span class="o">);</span>
 
@@ -315,7 +315,7 @@ <h4 id="creating-a-pcollection-from-in-memory-data">Creating a PCollection from
       <span class="s">"Or to take arms against a sea of troubles, "</span><span class="o">);</span>
 
     <span class="c1">// Create the pipeline.</span>
-    <span class="n">PipelineOptions</span> <span class="n">options</span> <span class="o">=</span> 
+    <span class="n">PipelineOptions</span> <span class="n">options</span> <span class="o">=</span>
         <span class="n">PipelineOptionsFactory</span><span class="o">.</span><span class="na">fromArgs</span><span class="o">(</span><span class="n">args</span><span class="o">).</span><span class="na">create</span><span class="o">();</span>
     <span class="n">Pipeline</span> <span class="n">p</span> <span class="o">=</span> <span class="n">Pipeline</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">options</span><span class="o">);</span>
 
diff --git a/content/documentation/runners/dataflow/index.html b/content/documentation/runners/dataflow/index.html
index cc4e51022cf..0367791a2b1 100644
--- a/content/documentation/runners/dataflow/index.html
+++ b/content/documentation/runners/dataflow/index.html
@@ -107,7 +107,7 @@
         <li class="dropdown-header">Technical References</li>
         <li><a href="/contribute/design-principles/">Design Principles</a></li>
 			  <li><a href="/contribute/work-in-progress/">Ongoing Projects</a></li>
-        <li><a href="/contribute/source-repository/">Source Repository</a></li>      
+        <li><a href="/contribute/source-repository/">Source Repository</a></li>
         <li role="separator" class="divider"></li>
 			  <li class="dropdown-header">Promotion</li>
         <li><a href="/contribute/presentation-materials/">Presentation Materials</a></li>
@@ -256,7 +256,7 @@ <h2 id="pipeline-options-for-the-cloud-dataflow-runner">Pipeline options for the
 </tr>
 </table>
 
-<p>See the reference documentation for the  <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html">DataflowPipelineOptions</a></span><span class="language-python"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py">PipelineOptions</a></span> interface (and its subinterfaces) for the complete list of pipeline configuration options.</p>
+<p>See the reference documentation for the  <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html">DataflowPipelineOptions</a></span><span class="language-python"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py">PipelineOptions</a></span> interface (and its subinterfaces) for the complete list of pipeline configuration options.</p>
 
 <h2 id="additional-information-and-caveats">Additional information and caveats</h2>
 
diff --git a/content/documentation/runners/direct/index.html b/content/documentation/runners/direct/index.html
index 53d07db82fa..d6ae8b8e9a9 100644
--- a/content/documentation/runners/direct/index.html
+++ b/content/documentation/runners/direct/index.html
@@ -107,7 +107,7 @@
         <li class="dropdown-header">Technical References</li>
         <li><a href="/contribute/design-principles/">Design Principles</a></li>
 			  <li><a href="/contribute/work-in-progress/">Ongoing Projects</a></li>
-        <li><a href="/contribute/source-repository/">Source Repository</a></li>      
+        <li><a href="/contribute/source-repository/">Source Repository</a></li>
         <li role="separator" class="divider"></li>
 			  <li class="dropdown-header">Promotion</li>
         <li><a href="/contribute/presentation-materials/">Presentation Materials</a></li>
@@ -180,7 +180,7 @@ <h2 id="pipeline-options-for-the-direct-runner">Pipeline options for the Direct
 
 <p>When executing your pipeline from the command-line, set <code class="highlighter-rouge">runner</code> to <code class="highlighter-rouge">direct</code>. The default values for the other pipeline options are generally sufficient.</p>
 
-<p>See the reference documentation for the  <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/runners/direct/DirectOptions.html"><code class="highlighter-rouge">DirectOptions</code></a></span><span class="language-python"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py"><code class="highlighter-rouge">PipelineOptions</code></a></span> interface (and its subinterfaces) for defaults and the complete list of pipeline configuration options.</p>
+<p>See the reference documentation for the  <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/runners/direct/DirectOptions.html"><code class="highlighter-rouge">DirectOptions</code></a></span><span class="language-python"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py"><code class="highlighter-rouge">PipelineOptions</code></a></span> interface (and its subinterfaces) for defaults and the complete list of pipeline configuration options.</p>
 
 <h2 id="additional-information-and-caveats">Additional information and caveats</h2>
 
diff --git a/content/documentation/runners/flink/index.html b/content/documentation/runners/flink/index.html
index d6fe0ebd10c..8a621fb99d8 100644
--- a/content/documentation/runners/flink/index.html
+++ b/content/documentation/runners/flink/index.html
@@ -107,7 +107,7 @@
         <li class="dropdown-header">Technical References</li>
         <li><a href="/contribute/design-principles/">Design Principles</a></li>
 			  <li><a href="/contribute/work-in-progress/">Ongoing Projects</a></li>
-        <li><a href="/contribute/source-repository/">Source Repository</a></li>      
+        <li><a href="/contribute/source-repository/">Source Repository</a></li>
         <li role="separator" class="divider"></li>
 			  <li class="dropdown-header">Promotion</li>
         <li><a href="/contribute/presentation-materials/">Presentation Materials</a></li>
@@ -271,7 +271,7 @@ <h2 id="pipeline-options-for-the-flink-runner">Pipeline options for the Flink Ru
 </tr>
 </table>
 
-<p>See the reference documentation for the  <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/runners/flink/FlinkPipelineOptions.html">FlinkPipelineOptions</a></span><span class="language-python"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py">PipelineOptions</a></span> interface (and its subinterfaces) for the complete list of pipeline configuration options.</p>
+<p>See the reference documentation for the  <span class="language-java"><a href="/documentation/sdks/javadoc/0.3.0-incubating/index.html?org/apache/beam/runners/flink/FlinkPipelineOptions.html">FlinkPipelineOptions</a></span><span class="language-python"><a href="https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py">PipelineOptions</a></span> interface (and its subinterfaces) for the complete list of pipeline configuration options.</p>
 
 <h2 id="additional-information-and-caveats">Additional information and caveats</h2>
 
diff --git a/src/documentation/programming-guide.md b/src/documentation/programming-guide.md
index 15528c5990c..d743c494364 100644
--- a/src/documentation/programming-guide.md
+++ b/src/documentation/programming-guide.md
@@ -77,7 +77,7 @@ To use Beam, your driver program must first create an instance of the Beam SDK c
 
 The pipeline configuration options determine, among other things, the `PipelineRunner` that determines where the pipeline gets executed: locally, or using a distributed back-end of your choice. Depending on where your pipeline gets executed and what your specifed Runner requires, the options can also help you specify other aspects of execution.
 
-To set your pipeline's configuration options and create the pipeline, create an object of type <span class="language-java">[PipelineOptions]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/sdk/options/PipelineOptions.html)</span><span class="language-py">[PipelineOptions](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py)</span> and pass it to `Pipeline.Create()`. The most common way to do this is by parsing arguments from the command-line:
+To set your pipeline's configuration options and create the pipeline, create an object of type <span class="language-java">[PipelineOptions]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/sdk/options/PipelineOptions.html)</span><span class="language-py">[PipelineOptions](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py)</span> and pass it to `Pipeline.Create()`. The most common way to do this is by parsing arguments from the command-line:
 
 ```java
 public static void main(String[] args) {
@@ -91,7 +91,7 @@ public static void main(String[] args) {
 ```
 
 ```py
-from apache_beam.utils.options import PipelineOptions
+from apache_beam.utils.pipeline_options import PipelineOptions
 
 # Will parse the arguments passed into the application and construct a PipelineOptions
 # Note that --help will print registered options.
diff --git a/src/documentation/runners/dataflow.md b/src/documentation/runners/dataflow.md
index 14a133cea6e..f707d4709a1 100644
--- a/src/documentation/runners/dataflow.md
+++ b/src/documentation/runners/dataflow.md
@@ -101,7 +101,7 @@ When executing your pipeline with the Cloud Dataflow Runner, set these pipeline
 </tr>
 </table>
 
-See the reference documentation for the  <span class="language-java">[DataflowPipelineOptions]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html)</span><span class="language-python">[PipelineOptions](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py)</span> interface (and its subinterfaces) for the complete list of pipeline configuration options.
+See the reference documentation for the  <span class="language-java">[DataflowPipelineOptions]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html)</span><span class="language-python">[PipelineOptions](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py)</span> interface (and its subinterfaces) for the complete list of pipeline configuration options.
 
 ## Additional information and caveats
 
diff --git a/src/documentation/runners/direct.md b/src/documentation/runners/direct.md
index b72b9338027..c96e7b82d72 100644
--- a/src/documentation/runners/direct.md
+++ b/src/documentation/runners/direct.md
@@ -37,7 +37,7 @@ You must specify your dependency on the Direct Runner.
 
 When executing your pipeline from the command-line, set `runner` to `direct`. The default values for the other pipeline options are generally sufficient.
 
-See the reference documentation for the  <span class="language-java">[`DirectOptions`]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/runners/direct/DirectOptions.html)</span><span class="language-python">[`PipelineOptions`](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py)</span> interface (and its subinterfaces) for defaults and the complete list of pipeline configuration options.
+See the reference documentation for the  <span class="language-java">[`DirectOptions`]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/runners/direct/DirectOptions.html)</span><span class="language-python">[`PipelineOptions`](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py)</span> interface (and its subinterfaces) for defaults and the complete list of pipeline configuration options.
 
 ## Additional information and caveats
 
diff --git a/src/documentation/runners/flink.md b/src/documentation/runners/flink.md
index 3fcbf461e6a..f2e59b52ebe 100644
--- a/src/documentation/runners/flink.md
+++ b/src/documentation/runners/flink.md
@@ -129,7 +129,7 @@ When executing your pipeline with the Flink Runner, you can set these pipeline o
 </tr>
 </table>
 
-See the reference documentation for the  <span class="language-java">[FlinkPipelineOptions]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/runners/flink/FlinkPipelineOptions.html)</span><span class="language-python">[PipelineOptions](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/options.py)</span> interface (and its subinterfaces) for the complete list of pipeline configuration options.
+See the reference documentation for the  <span class="language-java">[FlinkPipelineOptions]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/index.html?org/apache/beam/runners/flink/FlinkPipelineOptions.html)</span><span class="language-python">[PipelineOptions](https://github.com/apache/beam/blob/python-sdk/sdks/python/apache_beam/utils/pipeline_options.py)</span> interface (and its subinterfaces) for the complete list of pipeline configuration options.
 
 ## Additional information and caveats