org.apache.beam.sdk.io.jms

Class JmsIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<java.lang.String>,PDone>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

JmsIO

public abstract static class JmsIO.Write
extends PTransform<PCollection<java.lang.String>,PDone>

A PTransform to write to a JMS queue. 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
Write()

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<java.lang.String> input) Applies this PTransform on the given InputT, and returns its Output.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
JmsIO.Write	withConnectionFactory(javax.jms.ConnectionFactory connectionFactory) Specify the JMS connection factory to connect to the JMS broker.
JmsIO.Write	withPassword(java.lang.String password) Define the password to connect to the JMS broker (authenticated).
JmsIO.Write	withQueue(java.lang.String queue) Specify the JMS queue destination name where to send messages to.
JmsIO.Write	withTopic(java.lang.String topic) Specify the JMS topic destination name where to send messages to.
JmsIO.Write	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, populateDisplayData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

withConnectionFactory

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

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

For instance:

   
    .apply(JmsIO.write().withConnectionFactory(myConnectionFactory)
   
 

Parameters:

connectionFactory - The JMS ConnectionFactory.

Returns:

The corresponding JmsIO.Read.

withQueue

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

Specify the JMS queue destination name where to send messages to. The JmsIO.Write acts as a producer on the queue.

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

For instance:

   
    .apply(JmsIO.write().withQueue("my-queue")
   
 

Parameters:

queue - The JMS queue name where to send messages to.

Returns:

The corresponding JmsIO.Read.

withTopic

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

Specify the JMS topic destination name where to send messages to. The JmsIO.Read acts as a publisher on the topic.

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

For instance:

   
    .apply(JmsIO.write().withTopic("my-topic")
   
 

Parameters:

topic - The JMS topic name.

Returns:

The corresponding JmsIO.Read.

withUsername

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

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

withPassword

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

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

expand

public PDone expand(PCollection<java.lang.String> 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<PCollection<java.lang.String>,PDone>

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<PCollection<java.lang.String>,PDone>