org.apache.flink.streaming.connectors.rabbitmq

类 RMQSink<IN>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

org.apache.flink.streaming.connectors.rabbitmq.RMQSink<IN>

类型参数:

IN -

所有已实现的接口:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.streaming.api.functions.sink.SinkFunction<IN>

public class RMQSink<IN>
extends org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

A Sink for publishing data into RabbitMQ.

另请参阅:

序列化表格

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.streaming.api.functions.sink.SinkFunction

org.apache.flink.streaming.api.functions.sink.SinkFunction.Context

字段概要

字段

限定符和类型	字段和说明
protected com.rabbitmq.client.Channel	channel
protected com.rabbitmq.client.Connection	connection
protected String	queueName
protected org.apache.flink.api.common.serialization.SerializationSchema<IN>	schema

构造器概要

构造器

构造器和说明
RMQSink(RMQConnectionConfig rmqConnectionConfig, org.apache.flink.api.common.serialization.SerializationSchema<IN> schema, RMQSinkPublishOptions<IN> publishOptions)
RMQSink(RMQConnectionConfig rmqConnectionConfig, org.apache.flink.api.common.serialization.SerializationSchema<IN> schema, RMQSinkPublishOptions<IN> publishOptions, SerializableReturnListener returnListener)
RMQSink(RMQConnectionConfig rmqConnectionConfig, String queueName, org.apache.flink.api.common.serialization.SerializationSchema<IN> schema)

方法概要

限定符和类型	方法和说明
void	close()
void	invoke(IN value) Called when new data arrives to the sink, and forwards it to RMQ.
void	open(org.apache.flink.configuration.Configuration config)
void	setLogFailuresOnly(boolean logFailuresOnly) Defines whether the producer should fail on errors, or only log them.
protected com.rabbitmq.client.Connection	setupConnection() Initializes the connection to RMQ using the default connection factory from setupConnectionFactory().
protected com.rabbitmq.client.ConnectionFactory	setupConnectionFactory() Initializes the connection to RMQ with a default connection factory.
protected void	setupQueue() Sets up the queue.

从类继承的方法 org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.streaming.api.functions.sink.SinkFunction

invoke

字段详细资料

queueName

@Nullable
protected final String queueName

connection

protected transient com.rabbitmq.client.Connection connection

channel

protected transient com.rabbitmq.client.Channel channel

schema

protected org.apache.flink.api.common.serialization.SerializationSchema<IN> schema

构造器详细资料

RMQSink

@PublicEvolving
public RMQSink(RMQConnectionConfig rmqConnectionConfig,
                               String queueName,
                               org.apache.flink.api.common.serialization.SerializationSchema<IN> schema)

参数:

rmqConnectionConfig - The RabbitMQ connection configuration RMQConnectionConfig.

queueName - The queue to publish messages to.

schema - A SerializationSchema for turning the Java objects received into bytes

RMQSink

@PublicEvolving
public RMQSink(RMQConnectionConfig rmqConnectionConfig,
                               org.apache.flink.api.common.serialization.SerializationSchema<IN> schema,
                               RMQSinkPublishOptions<IN> publishOptions)

参数:

rmqConnectionConfig - The RabbitMQ connection configuration RMQConnectionConfig.

schema - A SerializationSchema for turning the Java objects received into bytes

publishOptions - A RMQSinkPublishOptions for providing message's routing key and/or properties In this case the computeMandatoy or computeImmediate MUST return false otherwise an IllegalStateException is raised during runtime.

RMQSink

@PublicEvolving
public RMQSink(RMQConnectionConfig rmqConnectionConfig,
                               org.apache.flink.api.common.serialization.SerializationSchema<IN> schema,
                               RMQSinkPublishOptions<IN> publishOptions,
                               SerializableReturnListener returnListener)

参数:

rmqConnectionConfig - The RabbitMQ connection configuration RMQConnectionConfig.

schema - A SerializationSchema for turning the Java objects received into bytes

publishOptions - A RMQSinkPublishOptions for providing message's routing key and/or properties

returnListener - A SerializableReturnListener implementation object to handle returned message event

方法详细资料

setupQueue

protected void setupQueue()
                   throws IOException

Sets up the queue. The default implementation just declares the queue. The user may override this method to have a custom setup for the queue (i.e. binding the queue to an exchange or defining custom queue parameters)

抛出:

IOException

setLogFailuresOnly

public void setLogFailuresOnly(boolean logFailuresOnly)

Defines whether the producer should fail on errors, or only log them. If this is set to true, then exceptions will be only logged, if set to false, exceptions will be eventually thrown and cause the streaming program to fail (and enter recovery).

参数:

logFailuresOnly - The flag to indicate logging-only on exceptions.

setupConnectionFactory

protected com.rabbitmq.client.ConnectionFactory setupConnectionFactory()
                                                                throws Exception

Initializes the connection to RMQ with a default connection factory. The user may override this method to setup and configure their own ConnectionFactory.

抛出:

Exception

setupConnection

protected com.rabbitmq.client.Connection setupConnection()
                                                  throws Exception

Initializes the connection to RMQ using the default connection factory from setupConnectionFactory(). The user may override this method to setup and configure their own Connection.

抛出:

Exception

open

public void open(org.apache.flink.configuration.Configuration config)
          throws Exception

指定者:

open 在接口中 org.apache.flink.api.common.functions.RichFunction

覆盖:

open 在类中 org.apache.flink.api.common.functions.AbstractRichFunction

抛出:

Exception

invoke

public void invoke(IN value)

Called when new data arrives to the sink, and forwards it to RMQ.

参数:

value - The incoming data

close

public void close()

指定者:

close 在接口中 org.apache.flink.api.common.functions.RichFunction

覆盖:

close 在类中 org.apache.flink.api.common.functions.AbstractRichFunction