org.apache.beam.sdk.io.jms

Class JmsIO.UnboundedJmsSource

java.lang.Object

org.apache.beam.sdk.io.Source<OutputT>

org.apache.beam.sdk.io.UnboundedSource<JmsRecord,JmsCheckpointMark>

org.apache.beam.sdk.io.jms.JmsIO.UnboundedJmsSource

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

JmsIO

protected static class JmsIO.UnboundedJmsSource
extends UnboundedSource<JmsRecord,JmsCheckpointMark>

An unbounded JMS source.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.UnboundedSource

UnboundedSource.CheckpointMark, UnboundedSource.UnboundedReader<OutputT>

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.Source

Source.Reader<T>

Constructor Summary

Constructors

Constructor and Description
UnboundedJmsSource(JmsIO.Read spec)

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.io.jms.JmsIO.UnboundedJmsReader	createReader(PipelineOptions options, JmsCheckpointMark checkpointMark) Create a new UnboundedSource.UnboundedReader to read from this source, resuming from the given checkpoint if present.
Coder<JmsCheckpointMark>	getCheckpointMarkCoder() Returns a Coder for encoding and decoding the checkpoints for this source.
Coder<JmsRecord>	getDefaultOutputCoder() Returns the default Coder to use for the data read from this source.
java.util.List<JmsIO.UnboundedJmsSource>	split(int desiredNumSplits, PipelineOptions options) Returns a list of UnboundedSource objects representing the instances of this source that should be used when executing the workflow.
void	validate() Checks that this source is valid, before it can be used in a pipeline.

Methods inherited from class org.apache.beam.sdk.io.UnboundedSource

requiresDeduping

Methods inherited from class org.apache.beam.sdk.io.Source

populateDisplayData

Methods inherited from class java.lang.Object

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

Constructor Detail

UnboundedJmsSource

public UnboundedJmsSource(JmsIO.Read spec)

Method Detail

split

public java.util.List<JmsIO.UnboundedJmsSource> split(int desiredNumSplits,
                                                      PipelineOptions options)
                                               throws java.lang.Exception

Description copied from class: UnboundedSource

Returns a list of UnboundedSource objects representing the instances of this source that should be used when executing the workflow. Each split should return a separate partition of the input data.

For example, for a source reading from a growing directory of files, each split could correspond to a prefix of file names.

Some sources are not splittable, such as reading from a single TCP stream. In that case, only a single split should be returned.

Some data sources automatically partition their data among readers. For these types of inputs, n identical replicas of the top-level source can be returned.

The size of the returned list should be as close to desiredNumSplits as possible, but does not have to match exactly. A low number of splits will limit the amount of parallelism in the source.

Specified by:

split in class UnboundedSource<JmsRecord,JmsCheckpointMark>

Throws:

java.lang.Exception

createReader

public org.apache.beam.sdk.io.jms.JmsIO.UnboundedJmsReader createReader(PipelineOptions options,
                                                                        JmsCheckpointMark checkpointMark)

Description copied from class: UnboundedSource

Create a new UnboundedSource.UnboundedReader to read from this source, resuming from the given checkpoint if present.

Specified by:

createReader in class UnboundedSource<JmsRecord,JmsCheckpointMark>

validate

public void validate()

Description copied from class: Source

Checks that this source is valid, before it can be used in a pipeline.

It is recommended to use Preconditions for implementing this method.

Specified by:

validate in class Source<JmsRecord>

getCheckpointMarkCoder

public Coder<JmsCheckpointMark> getCheckpointMarkCoder()

Description copied from class: UnboundedSource

Returns a Coder for encoding and decoding the checkpoints for this source.

Specified by:

getCheckpointMarkCoder in class UnboundedSource<JmsRecord,JmsCheckpointMark>

getDefaultOutputCoder

public Coder<JmsRecord> getDefaultOutputCoder()

Description copied from class: Source

Returns the default Coder to use for the data read from this source.

Specified by:

getDefaultOutputCoder in class Source<JmsRecord>