Run {@link injector.Injector} to generate pubsub data for this pipeline. The Injector + *
Run {@code injector.Injector} to generate pubsub data for this pipeline. The Injector * documentation provides more detail on how to do this. * *
To execute this pipeline using the Dataflow service, specify the pipeline configuration 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 32c939f32513..f4dca324f33e 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 @@ -68,7 +68,7 @@ * where the BigQuery dataset you specify must already exist. * *
Optionally include the --input argument to specify a batch input file.
- * See the --input default value for example batch data file, or use {@link injector.Injector} to
+ * See the --input default value for example batch data file, or use {@code injector.Injector} to
* generate your own batch data.
*/
public class UserScore {
diff --git a/pom.xml b/pom.xml
index 14c38fdee060..77e87bafa9f5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -160,6 +160,9 @@
nc -lk 9999
- * nc -lk 9999
+ * nc -lk 9999, and
- * nc -lk 9998
- * nc -lk 9999, and
+ * nc -lk 9998
+ * nc -lk 9999
- * nc -lk 9999
+ * Note that this coder standalone will not produce an Ism file. This coder can be used * to materialize a {@link PCollection} of {@link IsmRecord}s. Only when this coder - * is combined with an {@link IsmSink} will one produce an Ism file. + * is combined with an {@code IsmSink} will one produce an Ism file. * *
The {@link IsmRecord} encoded format is: *
Note that a token type of positive infinity is supported and is greater than
* all other {@link RandomAccessData}.
diff --git a/runners/spark/pom.xml b/runners/spark/pom.xml
index 0edafe84d9d7..a3ca296f57cc 100644
--- a/runners/spark/pom.xml
+++ b/runners/spark/pom.xml
@@ -413,10 +413,6 @@
By default, {@link AvroIO.Write} produces output files that are compressed using the - * {@link org.apache.avro.file.DeflateCodec CodecFactory.deflateCodec(6)}. This default can + * {@link org.apache.avro.file.Codec CodecFactory.deflateCodec(6)}. This default can * be changed or overridden using {@link AvroIO.Write#withCodec}. * - *
To use this class for supporting your custom input type, derive your class
- * class from it, and override the abstract methods. For an example, see {@link DatastoreIO}.
- *
* @param By default, returns null to indicate that this cannot be estimated.
*
- * Returns a {@code BoundedSource} representing the remainder.
*
- * These dependencies have been declared as optional in the sdks/java/core/pom.xml file of
* Apache Beam.
*
- * To enforce this contract, if there is no default, users must only call
- * {@link #get()} at execution time (after a call to {@link Pipeline#run}),
+ * {@link #get()} at execution time (after a call to {@link org.apache.beam.sdk.Pipeline#run}),
* which will provide the value of {@code optionsMap}.
*/
class RuntimeValueProvider Aggregators are visible in the monitoring UI, when the pipeline is run using
- * {@link DataflowRunner} along with their current value.
- * Aggregators may not become visible until the system begins executing the ParDo transform
- * that created them and/or their initial value is changed.
+ * It is runner-dependent whether aggregators are accessible during pipeline execution or only
+ * after jobs have completed.
*
* Example:
- * The same {@link TupleTag} cannot be used in a composition multiple times.
*
* Example:
- * Example usage:
*
- * For example:
*
- * Use this method if the type of metadata is not known at compile time. For example:
*
- * Example of performing a {@link CoGroupByKey} followed by a
* {@link ParDo} that consumes
* the results:
- * To read this stream:
- * The counts are encoded as variable length longs. See {@link VarInt#encode(long, OutputStream)}
* for more details. The end of the iterable is detected by reading a count of 0.
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
index 82d900c53037..f2a79bd0f7bf 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExecutionContext.java
@@ -41,14 +41,14 @@ public interface ExecutionContext {
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#output}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#output}
* is called.
*/
void noteOutput(WindowedValue output);
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#sideOutput}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#sideOutput}
* is called.
*/
void noteSideOutput(TupleTag tag, WindowedValue output);
@@ -70,14 +70,14 @@ public interface StepContext {
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#output}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#output}
* is called.
*/
void noteOutput(WindowedValue output);
/**
* Hook for subclasses to implement that will be called whenever
- * {@link OldDoFn.Context#sideOutput}
+ * {@link org.apache.beam.sdk.transforms.OldDoFn.Context#sideOutput}
* is called.
*/
void noteSideOutput(TupleTag tag, WindowedValue output);
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
index 020c45308f97..662ea38f3467 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayInputStream.java
@@ -30,8 +30,9 @@ public ExposedByteArrayInputStream(byte[] buf) {
super(buf);
}
- /** Read all remaining bytes.
- * @throws IOException */
+ /**
+ * Read all remaining bytes.
+ */
@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Returns internal buffer by design")
public byte[] readAll() throws IOException {
if (pos == 0 && count == buf.length) {
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
index e2c7e42917a6..e4a8062fe6b0 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/ExposedByteArrayOutputStream.java
@@ -62,8 +62,6 @@ private void fallback() {
* no content copy will be involved.
*
* Note: After passing any byte array to this method, it must not be modified again.
- *
- * @throws IOException
*/
@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Takes ownership of input buffer")
public void writeAndOwn(byte[] b) throws IOException {
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
index ce4604b7ac9c..54a963b05a6f 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsUtil.java
@@ -301,7 +301,6 @@ long fileSize(GcsPath path, BackOff backoff, Sleeper sleeper) throws IOException
*
* @param path the GCS filename to read from
* @return a SeekableByteChannel that can read the object data
- * @throws IOException
*/
public SeekableByteChannel open(GcsPath path)
throws IOException {
@@ -319,7 +318,6 @@ public SeekableByteChannel open(GcsPath path)
* @param path the GCS file to write to
* @param type the type of object, eg "text/plain".
* @return a Callable object that encloses the operation.
- * @throws IOException
*/
public WritableByteChannel create(GcsPath path,
String type) throws IOException {
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
index 7b30d346024e..a8239ce94510 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/MovingFunction.java
@@ -25,8 +25,8 @@
/**
* Keep track of the moving minimum/maximum/sum of sampled long values. The minimum/maximum/sum
- * is over at most the last {@link #samplePeriodMs}, and is updated every
- * {@link #sampleUpdateMs}.
+ * is over at most the user-specified last {@code samplePeriodMs}, and is updated every
+ * {@code sampleUpdateMs}.
*/
public class MovingFunction {
/**
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
index 1ac55119d14e..06b776b4b8e2 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/PubsubClient.java
@@ -90,10 +90,10 @@ private static Long asMsSinceEpoch(@Nullable String timestamp) {
* If {@code timestampLabel} is non-{@literal null} then the message attributes must contain
* that label, and the value of that label will be taken as the timestamp.
* Otherwise the timestamp will be taken from the Pubsub publish timestamp {@code
- * pubsubTimestamp}. Throw {@link IllegalArgumentException} if the timestamp cannot be
- * recognized as a ms-since-unix-epoch or RFC3339 time.
+ * pubsubTimestamp}.
*
- * @throws IllegalArgumentException
+ * @throws IllegalArgumentException if the timestamp cannot be recognized as a ms-since-unix-epoch
+ * or RFC3339 time.
*/
protected static long extractTimestamp(
@Nullable String timestampLabel,
@@ -115,7 +115,7 @@ protected static long extractTimestamp(
"Cannot interpret value of label %s as timestamp: %s",
timestampLabel, value);
}
- return timestampMsSinceEpoch == null ? 0 : timestampMsSinceEpoch;
+ return timestampMsSinceEpoch;
}
/**
@@ -443,8 +443,6 @@ public int hashCode() {
/**
* Publish {@code outgoingMessages} to Pubsub {@code topic}. Return number of messages
* published.
- *
- * @throws IOException
*/
public abstract int publish(TopicPath topic, List Examples:
* Examples:
* In pictures:
- * where
+ *
* Instances of {@code StateNamespace} are guaranteed to have a {@link #hashCode} and
- * {@link #equals} that uniquely identify the namespace.
+ * Instances of {@link StateNamespace} are guaranteed to have a {@link Object#hashCode} and
+ * {@link Object#equals} that uniquely identify the namespace.
*/
public interface StateNamespace {
/**
* Return a {@link String} representation of the key. It is guaranteed that this
- * {@code String} will uniquely identify the key.
+ * {@link String} will uniquely identify the key.
*
- * This will encode the actual namespace as a {@code String}. It is
- * preferable to use the {@code StateNamespace} object when possible.
+ * This will encode the actual namespace as a {@link String}. It is
+ * preferable to use the {@link StateNamespace} object when possible.
*
* The string produced by the standard implementations will not contain a '+' character. This
* enables adding a '+' between the actual namespace and other information, if needed, to separate
@@ -46,11 +46,11 @@ public interface StateNamespace {
void appendTo(Appendable sb) throws IOException;
/**
- * Return an {@code Object} to use as a key in a cache.
+ * Return an {@link Object} to use as a key in a cache.
*
* Different namespaces may use the same key in order to be treated as a unit in the cache.
- * The {@code Object}'s {@code hashCode} and {@code equals} methods will be used to determine
- * equality.
+ * The {@link Object}'s {@link Object#hashCode} and {@link Object#equals} methods will be used to
+ * determine equality.
*/
Object getCacheKey();
}
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
index 83d6a9232818..9e8cae4a299f 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PDone.java
@@ -24,7 +24,7 @@
/**
* {@link PDone} is the output of a {@link PTransform} that has a trivial result,
- * such as a {@link Write}.
+ * such as a {@link org.apache.beam.sdk.io.Write}.
*/
public class PDone extends POutputValueBase {
diff --git a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
index 3727f9215d36..1d1075c0cdbb 100644
--- a/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
+++ b/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/datastore/DatastoreV1.java
@@ -165,7 +165,7 @@
* read Entities, Properties,
* and Keys for more information about {@code Entity} keys.
*
- * Thread safety
+ * Thread safety
* If {@link #splitAtFraction} is implemented, this method can be called concurrently to other
* methods (including itself), and it is therefore critical for it to be implemented
* in a thread-safe way.
@@ -345,7 +342,7 @@ public long getSplitPointsRemaining() {
*
* Detailed description
+ * Detailed description
* Assuming the following sequence of calls:
* {@code
* BoundedSourceStatefulness
+ * Statefulness
* Since this method (if successful) affects the reader's source, in subsequent invocations
* "fraction" should be interpreted relative to the new current source.
*
- * Thread safety and blocking
+ * Thread safety and blocking
* This method will be called concurrently to other methods (however there will not be multiple
* concurrent invocations of this method itself), and it is critical for it to be implemented
* in a thread-safe way (otherwise data loss is possible).
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
index f33b9bd36629..af0c8130a324 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/CompressedSource.java
@@ -74,7 +74,6 @@ public class CompressedSourcePermissions
+ * Permissions
* Permission requirements depend on the
* {@link org.apache.beam.sdk.runners.PipelineRunner PipelineRunner} that is
* used to execute the Beam pipeline. Please refer to the documentation of corresponding
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
index 30634411255e..e30f8af911b0 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/range/ByteKeyRange.java
@@ -133,7 +133,7 @@ public Boolean overlaps(ByteKeyRange other) {
* Specifically, if this range is unsplittable (e.g., because the start and end keys are equal
* up to padding by zero bytes), the list returned will only contain the start and end key.
*
- * @throws IllegalArgumentException if the specified number of splits is < 1
+ * @throws IllegalArgumentException if the specified number of splits is less than 1
* @see ByteKeyRange the ByteKeyRange class Javadoc for more information about split semantics.
*/
public List {@code
+ *
*
* @param {@code
* class MyDoFn extends DoFn
+ * }<{@code
+ * {@code
* PCollection {@code
+ *
*
* @param {@code
* PCollection
+ * }{@code
* new DoFn{@code
* new DoFn
*
<{@code
+ * {@code
* PCollection
- * {@code
- * @Override
+ * {@code
+ * {@literal @}Override
* public void populateDisplayData(DisplayData.Builder builder) {
* Optional
*
* {@code
+ *
*
* @param {@code
* PCollection
+ * }{@code
- * @Override
+ * {@literal @}Override
* StreamingModeExecutionContext.StepContext getOrCreateStepContext(...) {
* return (StreamingModeExecutionContext.StepContext) super.getOrCreateStepContext(...);
* }
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
index c17d92d41f8a..b0784cad2bc0 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/BufferedElementCountingOutputStream.java
@@ -49,7 +49,7 @@
*
*
*
+ * }
+ * {@code
* InputStream is = ...
* long count;
* do {
@@ -58,7 +58,7 @@
* // read an element from is
* }
* } while(count > 0);
- *
- *
*
* @throws IllegalArgumentException if the class is anonymous
@@ -143,8 +143,8 @@ public static String approximateSimpleName(Class clazz) {
*
*
- *
*/
public static String approximatePTransformName(Class clazz) {
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
index 8015116d52cc..743f3f796918 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/TimerInternals.java
@@ -128,15 +128,17 @@ public interface TimerInternals {
*
*
*
+ *
+ *
+ * {@code
* | | | | |
* | | D | C | B | A
* | | | | |
* GIWM <= GOWM <= LOWM <= LIWM <= GIWM
* (next stage)
* -------------------------------------------------> event time
- *
- * where
+ * }
*
Permissions
+ * Permissions
* Permission requirements depend on the {@code PipelineRunner} that is used to execute the
* Dataflow job. Please refer to the documentation of corresponding {@code PipelineRunner}s for
* more details.
diff --git a/sdks/java/io/jdbc/pom.xml b/sdks/java/io/jdbc/pom.xml
index a65ed4614477..2eb24bd4dbb6 100644
--- a/sdks/java/io/jdbc/pom.xml
+++ b/sdks/java/io/jdbc/pom.xml
@@ -48,10 +48,6 @@
{@code}
+ * {@code
* p.
* apply(KinesisIO.Read.
* from("streamName", InitialPositionInStream.LATEST).
* using("AWS_KEY", _"AWS_SECRET", STREAM_REGION).
* apply( ... ) // other transformations
- *
- *
+ * }
*
- * - * As you can see you need to provide 3 things: + *
As you can see you need to provide 3 things: *
In case when you want to set up {@link AmazonKinesis} client by your own * (for example if you're using more sophisticated authorization methods like Amazon STS, etc.) @@ -73,35 +70,33 @@ * *
{@code
* public class MyCustomKinesisClientProvider implements KinesisClientProvider {
- * @Override
+ * {@literal @}Override
* public AmazonKinesis get() {
* // set up your client here
* }
- * }}
- *
+ * }
+ * }
*
- * Usage is pretty straightforward:
+ * Usage is pretty straightforward: * - *
{@code}
+ * {@code
* p.
* apply(KinesisIO.Read.
* from("streamName", InitialPositionInStream.LATEST).
* using(MyCustomKinesisClientProvider()).
* apply( ... ) // other transformations
- *
- *
+ * }
*
* There’s also possibility to start reading using arbitrary point in time - * in this case you need to provide {@link Instant} object: * - *
{@code}
+ * {@code
* p.
* apply(KinesisIO.Read.
* from("streamName", instant).
* using(MyCustomKinesisClientProvider()).
* apply( ... ) // other transformations
- *
- *
+ * }
*
*/
public final class KinesisIO {
diff --git a/sdks/java/io/mongodb/pom.xml b/sdks/java/io/mongodb/pom.xml
index d674e63e8329..d0ae6ace4c62 100644
--- a/sdks/java/io/mongodb/pom.xml
+++ b/sdks/java/io/mongodb/pom.xml
@@ -48,10 +48,6 @@