org.apache.flink.streaming.connectors.cassandra

Class CassandraSink.CassandraSinkBuilder<IN>

java.lang.Object

org.apache.flink.streaming.connectors.cassandra.CassandraSink.CassandraSinkBuilder<IN>

Type Parameters:

IN -

Direct Known Subclasses:

CassandraSink.CassandraPojoSinkBuilder, CassandraSink.CassandraRowSinkBuilder, CassandraSink.CassandraScalaProductSinkBuilder, CassandraSink.CassandraTupleSinkBuilder

Enclosing class:

CassandraSink<IN>

public abstract static class CassandraSink.CassandraSinkBuilder<IN>
extends Object

Builder for a CassandraSink.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterBuilder	builder
protected CheckpointCommitter	committer
protected DataStream<IN>	input
protected boolean	isWriteAheadLogEnabled
protected MapperOptions	mapperOptions
protected String	query
protected TypeSerializer<IN>	serializer
protected TypeInformation<IN>	typeInfo

Constructor Summary

Constructors

Constructor and Description
CassandraSinkBuilder(DataStream<IN> input, TypeInformation<IN> typeInfo, TypeSerializer<IN> serializer)

Method Summary

Modifier and Type	Method and Description
CassandraSink<IN>	build() Finalizes the configuration of this sink.
protected abstract CassandraSink<IN>	createSink()
protected abstract CassandraSink<IN>	createWriteAheadSink()
CassandraSink.CassandraSinkBuilder<IN>	enableWriteAheadLog() Enables the write-ahead log, which allows exactly-once processing for non-deterministic algorithms that use idempotent updates.
CassandraSink.CassandraSinkBuilder<IN>	enableWriteAheadLog(CheckpointCommitter committer) Enables the write-ahead log, which allows exactly-once processing for non-deterministic algorithms that use idempotent updates.
protected void	sanityCheck()
CassandraSink.CassandraSinkBuilder<IN>	setClusterBuilder(ClusterBuilder builder) Sets the ClusterBuilder for this sink.
CassandraSink.CassandraSinkBuilder<IN>	setHost(String host) Sets the cassandra host to connect to.
CassandraSink.CassandraSinkBuilder<IN>	setHost(String host, int port) Sets the cassandra host/port to connect to.
CassandraSink.CassandraSinkBuilder<IN>	setMapperOptions(MapperOptions options) Sets the mapper options for this sink.
CassandraSink.CassandraSinkBuilder<IN>	setQuery(String query) Sets the query that is to be executed for every record.

Methods inherited from class java.lang.Object

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

Field Detail

input

protected final DataStream<IN> input

serializer

protected final TypeSerializer<IN> serializer

typeInfo

protected final TypeInformation<IN> typeInfo

builder

protected ClusterBuilder builder

mapperOptions

protected MapperOptions mapperOptions

query

protected String query

committer

protected CheckpointCommitter committer

isWriteAheadLogEnabled

protected boolean isWriteAheadLogEnabled

Constructor Detail

CassandraSinkBuilder

public CassandraSinkBuilder(DataStream<IN> input,
                            TypeInformation<IN> typeInfo,
                            TypeSerializer<IN> serializer)

Method Detail

setQuery

public CassandraSink.CassandraSinkBuilder<IN> setQuery(String query)

Sets the query that is to be executed for every record.

Parameters:

query - query to use

Returns:

this builder

setHost

public CassandraSink.CassandraSinkBuilder<IN> setHost(String host)

Sets the cassandra host to connect to.

Parameters:

host - host to connect to

Returns:

this builder

setHost

public CassandraSink.CassandraSinkBuilder<IN> setHost(String host,
                                                      int port)

Sets the cassandra host/port to connect to.

Parameters:

host - host to connect to

port - port to connect to

Returns:

this builder

setClusterBuilder

public CassandraSink.CassandraSinkBuilder<IN> setClusterBuilder(ClusterBuilder builder)

Sets the ClusterBuilder for this sink. A ClusterBuilder is used to configure the connection to cassandra.

Parameters:

builder - ClusterBuilder to configure the connection to cassandra

Returns:

this builder

enableWriteAheadLog

public CassandraSink.CassandraSinkBuilder<IN> enableWriteAheadLog()

Enables the write-ahead log, which allows exactly-once processing for non-deterministic algorithms that use idempotent updates.

Returns:

this builder

enableWriteAheadLog

public CassandraSink.CassandraSinkBuilder<IN> enableWriteAheadLog(CheckpointCommitter committer)

Enables the write-ahead log, which allows exactly-once processing for non-deterministic algorithms that use idempotent updates.

Parameters:

committer - CheckpointCommitter, that stores information about completed checkpoints in an external resource. By default this information is stored within a separate table within Cassandra.

Returns:

this builder

setMapperOptions

public CassandraSink.CassandraSinkBuilder<IN> setMapperOptions(MapperOptions options)

Sets the mapper options for this sink. The mapper options are used to configure the DataStax Mapper when writing POJOs.

This call has no effect if the input DataStream for this sink does not contain POJOs.

Parameters:

options - MapperOptions, that return an array of options that are used to configure the DataStax mapper.

Returns:

this builder

build

public CassandraSink<IN> build()
                        throws Exception

Finalizes the configuration of this sink.

Returns:

finalized sink

Throws:

Exception

createSink

protected abstract CassandraSink<IN> createSink()
                                         throws Exception

Throws:

Exception

createWriteAheadSink

protected abstract CassandraSink<IN> createWriteAheadSink()
                                                   throws Exception

Throws:

Exception

sanityCheck

protected void sanityCheck()