org.apache.beam.sdk.io.rabbitmq

Class RabbitMqIO.Read

java.lang.Object

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

org.apache.beam.sdk.io.rabbitmq.RabbitMqIO.Read

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

RabbitMqIO

public abstract static class RabbitMqIO.Read
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<RabbitMqMessage>>

A PTransform to consume messages from RabbitMQ server.

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
org.apache.beam.sdk.values.PCollection<RabbitMqMessage>	expand(org.apache.beam.sdk.values.PBegin input)
RabbitMqIO.Read	withExchange(java.lang.String name, java.lang.String type, java.lang.String routingKey) Instead of consuming messages on a specific queue, you can consume message from a given exchange.
RabbitMqIO.Read	withMaxNumRecords(long maxNumRecords) Define the max number of records received by the RabbitMqIO.Read.
RabbitMqIO.Read	withMaxReadTime(org.joda.time.Duration maxReadTime) Define the max read time (duration) while the RabbitMqIO.Read will receive messages.
RabbitMqIO.Read	withQueue(java.lang.String queue) If you want to directly consume messages from a specific queue, you just have to specify the queue name.
RabbitMqIO.Read	withQueueDeclare(boolean queueDeclare) You can "force" the declaration of a queue on the RabbitMQ broker.
RabbitMqIO.Read	withUri(java.lang.String uri)

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

compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, populateDisplayData, toString, validate

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 RabbitMqIO.Read withUri(java.lang.String uri)

withQueue

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

If you want to directly consume messages from a specific queue, you just have to specify the queue name. Optionally, you can declare the queue using withQueueDeclare(boolean).

withQueueDeclare

public RabbitMqIO.Read withQueueDeclare(boolean queueDeclare)

You can "force" the declaration of a queue on the RabbitMQ broker. Exchanges and queues are the high-level building blocks of AMQP. These must be "declared" before they can be used. Declaring either type of object simply ensures that one of that name exists, creating it if necessary.

Parameters:

queueDeclare - If true, RabbitMqIO will declare the queue. If another application declare the queue, it's not required.

withExchange

public RabbitMqIO.Read withExchange(java.lang.String name,
                                    java.lang.String type,
                                    java.lang.String routingKey)

Instead of consuming messages on a specific queue, you can consume message from a given exchange. Then you specify the exchange name, type and optionally routing key where you want to consume messages.

withMaxNumRecords

public RabbitMqIO.Read withMaxNumRecords(long maxNumRecords)

Define the max number of records received by the RabbitMqIO.Read. When this max number of records is lower than Long.MAX_VALUE, the RabbitMqIO.Read will provide a bounded PCollection.

withMaxReadTime

public RabbitMqIO.Read withMaxReadTime(org.joda.time.Duration maxReadTime)

Define the max read time (duration) while the RabbitMqIO.Read will receive messages. When this max read time is not null, the RabbitMqIO.Read will provide a bounded PCollection.

expand

public org.apache.beam.sdk.values.PCollection<RabbitMqMessage> expand(org.apache.beam.sdk.values.PBegin input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<RabbitMqMessage>>