org.apache.beam.sdk.io.jms

Class JmsIO.Read

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

JmsIO

public abstract static class JmsIO.Read
extends PTransform<PBegin,PCollection<JmsRecord>>

A PTransform to read from a JMS destination. See JmsIO for more information on usage and configuration.

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<JmsRecord>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
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.
JmsIO.Read	withConnectionFactory(javax.jms.ConnectionFactory connectionFactory) Specify the JMS connection factory to connect to the JMS broker.
JmsIO.Read	withMaxNumRecords(long maxNumRecords) Define the max number of records that the source will read.
JmsIO.Read	withMaxReadTime(Duration maxReadTime) Define the max read time that the source will read.
JmsIO.Read	withPassword(java.lang.String password) Define the password to connect to the JMS broker (authenticated).
JmsIO.Read	withQueue(java.lang.String queue) Specify the JMS queue destination name where to read messages from.
JmsIO.Read	withTopic(java.lang.String topic) Specify the JMS topic destination name where to receive messages from.
JmsIO.Read	withUsername(java.lang.String username) Define the username to connect to the JMS broker (authenticated).

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

withConnectionFactory

public JmsIO.Read withConnectionFactory(javax.jms.ConnectionFactory connectionFactory)

Specify the JMS connection factory to connect to the JMS broker.

For instance:

   
    pipeline.apply(JmsIO.read().withConnectionFactory(myConnectionFactory)
   
 

Parameters:

connectionFactory - The JMS ConnectionFactory.

Returns:

The corresponding JmsIO.Read.

withQueue

public JmsIO.Read withQueue(java.lang.String queue)

Specify the JMS queue destination name where to read messages from. The JmsIO.Read acts as a consumer on the queue.

This method is exclusive with withTopic(String). The user has to specify a destination: queue or topic.

For instance:

   
    pipeline.apply(JmsIO.read().withQueue("my-queue")
   
 

Parameters:

queue - The JMS queue name where to read messages from.

Returns:

The corresponding JmsIO.Read.

withTopic

public JmsIO.Read withTopic(java.lang.String topic)

Specify the JMS topic destination name where to receive messages from. The JmsIO.Read acts as a subscriber on the topic.

This method is exclusive with withQueue(String). The user has to specify a destination: queue or topic.

For instance:

   
    pipeline.apply(JmsIO.read().withTopic("my-topic")
   
 

Parameters:

topic - The JMS topic name.

Returns:

The corresponding JmsIO.Read.

withUsername

public JmsIO.Read withUsername(java.lang.String username)

Define the username to connect to the JMS broker (authenticated).

withPassword

public JmsIO.Read withPassword(java.lang.String password)

Define the password to connect to the JMS broker (authenticated).

withMaxNumRecords

public JmsIO.Read withMaxNumRecords(long maxNumRecords)

Define the max number of records that the source will read. Using a max number of records different from Long.MAX_VALUE means the source will be Bounded, and will stop once the max number of records read is reached.

For instance:

   
    pipeline.apply(JmsIO.read().withNumRecords(1000)
   
 

Parameters:

maxNumRecords - The max number of records to read from the JMS destination.

Returns:

The corresponding JmsIO.Read.

withMaxReadTime

public JmsIO.Read withMaxReadTime(Duration maxReadTime)

Define the max read time that the source will read. Using a non null max read time duration means the source will be Bounded, and will stop once the max read time is reached.

For instance:

   
    pipeline.apply(JmsIO.read().withMaxReadTime(Duration.minutes(10))
   
 

Parameters:

maxReadTime - The max read time duration.

Returns:

The corresponding JmsIO.Read.

expand

public PCollection<JmsRecord> expand(PBegin input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

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<JmsRecord>>

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<JmsRecord>>

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<JmsRecord>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData