beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k...@apache.org
Subject [1/2] beam git commit: Correct javadoc for mobile gaming examples
Date Wed, 10 May 2017 23:58:50 GMT
Repository: beam
Updated Branches:
  refs/heads/release-2.0.0 24914cbf2 -> e08cac055


Correct javadoc for mobile gaming examples


Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/9fdd2e03
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/9fdd2e03
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/9fdd2e03

Branch: refs/heads/release-2.0.0
Commit: 9fdd2e03280abff883f8a1448aa2d1f243a42b2c
Parents: 24914cb
Author: Kenneth Knowles <klk@google.com>
Authored: Wed May 10 16:41:00 2017 -0700
Committer: Kenneth Knowles <klk@google.com>
Committed: Wed May 10 16:45:52 2017 -0700

----------------------------------------------------------------------
 .../org/apache/beam/examples/complete/game/GameStats.java |  8 ++++----
 .../beam/examples/complete/game/HourlyTeamScore.java      |  5 ++---
 .../apache/beam/examples/complete/game/LeaderBoard.java   | 10 +++++-----
 .../org/apache/beam/examples/complete/game/UserScore.java | 10 ++++------
 4 files changed, 15 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam/blob/9fdd2e03/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
index abbb13b..dbc7f88 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
@@ -78,17 +78,17 @@ import org.slf4j.LoggerFactory;
  * <p>Run {@code org.apache.beam.examples.complete.game.injector.Injector} to generate
  * pubsub data for this pipeline. The {@code Injector} documentation provides more detail.
  *
- * <p>To execute this pipeline using the Dataflow service, specify the pipeline configuration
- * like this:
+ * <p>To execute this pipeline, specify the pipeline configuration like this:
  * <pre>{@code
  *   --project=YOUR_PROJECT_ID
  *   --tempLocation=gs://YOUR_TEMP_DIRECTORY
- *   --runner=BlockingDataflowRunner
+ *   --runner=YOUR_RUNNER
  *   --dataset=YOUR-DATASET
  *   --topic=projects/YOUR-PROJECT/topics/YOUR-TOPIC
  * }
  * </pre>
- * where the BigQuery dataset you specify must already exist. The PubSub topic you specify
should
+ *
+ * <p>The BigQuery dataset you specify must already exist. The PubSub topic you specify
should
  * be the same topic to which the Injector is publishing.
  */
 public class GameStats extends LeaderBoard {

http://git-wip-us.apache.org/repos/asf/beam/blob/9fdd2e03/examples/java8/src/main/java/org/apache/beam/examples/complete/game/HourlyTeamScore.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/HourlyTeamScore.java
b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/HourlyTeamScore.java
index 6a322da..bab74ce 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/HourlyTeamScore.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/HourlyTeamScore.java
@@ -53,13 +53,12 @@ import org.joda.time.format.DateTimeFormatter;
  * {@link UserScore} pipeline. However, our batch processing is high-latency, in that we
don't get
  * results from plays at the beginning of the batch's time period until the batch is processed.
  *
- * <p>To execute this pipeline using the Dataflow service, specify the pipeline configuration
- * like this:
+ * <p>To execute this pipeline, specify the pipeline configuration like this:
  * <pre>{@code
- *   --project=YOUR_PROJECT_ID
  *   --tempLocation=YOUR_TEMP_DIRECTORY
  *   --runner=YOUR_RUNNER
  *   --output=YOUR_OUTPUT_DIRECTORY
+ *   (possibly options specific to your runner or permissions for your temp/output locations)
  * }
  * </pre>
  *

http://git-wip-us.apache.org/repos/asf/beam/blob/9fdd2e03/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
index f673a8d..b879b70 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
@@ -77,18 +77,18 @@ import org.joda.time.format.DateTimeFormatter;
  * <p>Run {@code injector.Injector} to generate pubsub data for this pipeline.  The
Injector
  * documentation provides more detail on how to do this.
  *
- * <p>To execute this pipeline using the Dataflow service, specify the pipeline configuration
- * like this:
+ * <p>To execute this pipeline, specify the pipeline configuration like this:
  * <pre>{@code
  *   --project=YOUR_PROJECT_ID
  *   --tempLocation=gs://YOUR_TEMP_DIRECTORY
- *   --runner=BlockingDataflowRunner
+ *   --runner=YOUR_RUNNER
  *   --dataset=YOUR-DATASET
  *   --topic=projects/YOUR-PROJECT/topics/YOUR-TOPIC
  * }
  * </pre>
- * where the BigQuery dataset you specify must already exist.
- * The PubSub topic you specify should be the same topic to which the Injector is publishing.
+ *
+ * <p>The BigQuery dataset you specify must already exist. The PubSub topic you specify
should be
+ * the same topic to which the Injector is publishing.
  */
 public class LeaderBoard extends HourlyTeamScore {
 

http://git-wip-us.apache.org/repos/asf/beam/blob/9fdd2e03/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
----------------------------------------------------------------------
diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
index 7297bcd..ee7b792 100644
--- a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
+++ b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
@@ -45,8 +45,8 @@ import org.slf4j.LoggerFactory;
 
 /**
  * This class is the first in a series of four pipelines that tell a story in a 'gaming'
domain.
- * Concepts: batch processing; reading input from Google Cloud Storage and writing output
to
- * BigQuery; using standalone DoFns; use of the sum by key transform; examples of
+ * Concepts: batch processing, reading input from text files, writing output to
+ * text files, using standalone DoFns, use of the sum per key transform, and use of
  * Java 8 lambda syntax.
  *
  * <p>In this gaming scenario, many users play, as members of different teams, over
the course of a
@@ -57,16 +57,14 @@ import org.slf4j.LoggerFactory;
  * sum of scores per user, over an entire batch of gaming data (collected, say, for each
day). The
  * batch processing will not include any late data that arrives after the day's cutoff point.
  *
- * <p>To execute this pipeline using the Dataflow service and static example input
data, specify
- * the pipeline configuration like this:
+ * <p>To execute this pipeline, specify the pipeline configuration like this:
  * <pre>{@code
- *   --project=YOUR_PROJECT_ID
  *   --tempLocation=YOUR_TEMP_DIRECTORY
  *   --runner=YOUR_RUNNER
  *   --output=YOUR_OUTPUT_DIRECTORY
+ *   (possibly options specific to your runner or permissions for your temp/output locations)
  * }
  * </pre>
- * where the BigQuery dataset you specify must already exist.
  *
  * <p>Optionally include the --input argument to specify a batch input file.
  * See the --input default value for example batch data file, or use {@code injector.Injector}
to


Mime
View raw message