org.apache.beam.sdk.io.mongodb

Class MongoDbIO.Read

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<org.bson.Document>>

org.apache.beam.sdk.io.mongodb.MongoDbIO.Read

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

MongoDbIO

public abstract static class MongoDbIO.Read
extends PTransform<PBegin,PCollection<org.bson.Document>>

A PTransform to read data from MongoDB.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<org.bson.Document>	expand(PBegin input) Applies this PTransform on the given InputT, and returns its Output.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
MongoDbIO.Read	withCollection(java.lang.String collection)
MongoDbIO.Read	withDatabase(java.lang.String database)
MongoDbIO.Read	withFilter(java.lang.String filter)
MongoDbIO.Read	withNumSplits(int numSplits)
MongoDbIO.Read	withUri(java.lang.String uri) Example documentation for withUri.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Read

public Read()

Method Detail

withUri

public MongoDbIO.Read withUri(java.lang.String uri)

Example documentation for withUri.

withDatabase

public MongoDbIO.Read withDatabase(java.lang.String database)

withCollection

public MongoDbIO.Read withCollection(java.lang.String collection)

withFilter

public MongoDbIO.Read withFilter(java.lang.String filter)

withNumSplits

public MongoDbIO.Read withNumSplits(int numSplits)

expand

public PCollection<org.bson.Document> expand(PBegin input)

Description copied from class: PTransform

Applies this PTransform on the given InputT, and returns its Output.

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).

Specified by:

expand in class PTransform<PBegin,PCollection<org.bson.Document>>

validate

public void validate(PipelineOptions options)

Description copied from class: PTransform

Called before running the Pipeline to verify this transform is fully and correctly specified.

By default, does nothing.

Overrides:

validate in class PTransform<PBegin,PCollection<org.bson.Document>>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PBegin,PCollection<org.bson.Document>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData