org.apache.beam.sdk.io.cassandra

Class CassandraIO.Read<T>

java.lang.Object

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

org.apache.beam.sdk.io.cassandra.CassandraIO.Read<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

CassandraIO

public abstract static class CassandraIO.Read<T>
extends PTransform<PBegin,PCollection<T>>

A PTransform to read data from Apache Cassandra. See CassandraIO 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<T>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
CassandraIO.Read<T>	withCoder(Coder<T> coder) Specify the Coder used to serialize the entity in the PCollection.
CassandraIO.Read<T>	withConsistencyLevel(java.lang.String consistencyLevel)
CassandraIO.Read<T>	withConsistencyLevel(ValueProvider<java.lang.String> consistencyLevel)
CassandraIO.Read<T>	withEntity(java.lang.Class<T> entity) Specify the entity class (annotated POJO).
CassandraIO.Read<T>	withHosts(java.util.List<java.lang.String> hosts) Specify the hosts of the Apache Cassandra instances.
CassandraIO.Read<T>	withHosts(ValueProvider<java.util.List<java.lang.String>> hosts) Specify the hosts of the Apache Cassandra instances.
CassandraIO.Read<T>	withKeyspace(java.lang.String keyspace) Specify the Cassandra keyspace where to read data.
CassandraIO.Read<T>	withKeyspace(ValueProvider<java.lang.String> keyspace) Specify the Cassandra keyspace where to read data.
CassandraIO.Read<T>	withLocalDc(java.lang.String localDc) Specify the local DC used for the load balancing.
CassandraIO.Read<T>	withLocalDc(ValueProvider<java.lang.String> localDc) Specify the local DC used for the load balancing.
CassandraIO.Read<T>	withMapperFactoryFn(SerializableFunction<com.datastax.driver.core.Session,Mapper> mapperFactory) A factory to create a specific Mapper for a given Cassandra Session.
CassandraIO.Read<T>	withMinNumberOfSplits(java.lang.Integer minNumberOfSplits) It's possible that system.size_estimates isn't populated or that the number of splits computed by Beam is still to low for Cassandra to handle it.
CassandraIO.Read<T>	withMinNumberOfSplits(ValueProvider<java.lang.Integer> minNumberOfSplits) It's possible that system.size_estimates isn't populated or that the number of splits computed by Beam is still to low for Cassandra to handle it.
CassandraIO.Read<T>	withPassword(java.lang.String password) Specify the password for authentication.
CassandraIO.Read<T>	withPassword(ValueProvider<java.lang.String> password) Specify the clear password for authentication.
CassandraIO.Read<T>	withPort(int port) Specify the port number of the Apache Cassandra instances.
CassandraIO.Read<T>	withPort(ValueProvider<java.lang.Integer> port) Specify the port number of the Apache Cassandra instances.
CassandraIO.Read<T>	withQuery(java.lang.String query) Specify the query to read data.
CassandraIO.Read<T>	withQuery(ValueProvider<java.lang.String> query) Specify the query to read data.
CassandraIO.Read<T>	withTable(java.lang.String table) Specify the Cassandra table where to read data.
CassandraIO.Read<T>	withTable(ValueProvider<java.lang.String> table) Specify the Cassandra table where to read data.
CassandraIO.Read<T>	withUsername(java.lang.String username) Specify the username for authentication.
CassandraIO.Read<T>	withUsername(ValueProvider<java.lang.String> username) Specify the username for authentication.

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

compose, 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

withHosts

public CassandraIO.Read<T> withHosts(java.util.List<java.lang.String> hosts)

Specify the hosts of the Apache Cassandra instances.

withHosts

public CassandraIO.Read<T> withHosts(ValueProvider<java.util.List<java.lang.String>> hosts)

Specify the hosts of the Apache Cassandra instances.

withPort

public CassandraIO.Read<T> withPort(int port)

Specify the port number of the Apache Cassandra instances.

withPort

public CassandraIO.Read<T> withPort(ValueProvider<java.lang.Integer> port)

Specify the port number of the Apache Cassandra instances.

withKeyspace

public CassandraIO.Read<T> withKeyspace(java.lang.String keyspace)

Specify the Cassandra keyspace where to read data.

withKeyspace

public CassandraIO.Read<T> withKeyspace(ValueProvider<java.lang.String> keyspace)

Specify the Cassandra keyspace where to read data.

withTable

public CassandraIO.Read<T> withTable(java.lang.String table)

Specify the Cassandra table where to read data.

withTable

public CassandraIO.Read<T> withTable(ValueProvider<java.lang.String> table)

Specify the Cassandra table where to read data.

withQuery

public CassandraIO.Read<T> withQuery(java.lang.String query)

Specify the query to read data.

withQuery

public CassandraIO.Read<T> withQuery(ValueProvider<java.lang.String> query)

Specify the query to read data.

withEntity

public CassandraIO.Read<T> withEntity(java.lang.Class<T> entity)

Specify the entity class (annotated POJO). The CassandraIO will read the data and convert the data as entity instances. The PCollection resulting from the read will contains entity elements.

withCoder

public CassandraIO.Read<T> withCoder(Coder<T> coder)

Specify the Coder used to serialize the entity in the PCollection.

withUsername

public CassandraIO.Read<T> withUsername(java.lang.String username)

Specify the username for authentication.

withUsername

public CassandraIO.Read<T> withUsername(ValueProvider<java.lang.String> username)

Specify the username for authentication.

withPassword

public CassandraIO.Read<T> withPassword(java.lang.String password)

Specify the password for authentication.

withPassword

public CassandraIO.Read<T> withPassword(ValueProvider<java.lang.String> password)

Specify the clear password for authentication.

withLocalDc

public CassandraIO.Read<T> withLocalDc(java.lang.String localDc)

Specify the local DC used for the load balancing.

withLocalDc

public CassandraIO.Read<T> withLocalDc(ValueProvider<java.lang.String> localDc)

Specify the local DC used for the load balancing.

withConsistencyLevel

public CassandraIO.Read<T> withConsistencyLevel(java.lang.String consistencyLevel)

withConsistencyLevel

public CassandraIO.Read<T> withConsistencyLevel(ValueProvider<java.lang.String> consistencyLevel)

withMinNumberOfSplits

public CassandraIO.Read<T> withMinNumberOfSplits(java.lang.Integer minNumberOfSplits)

It's possible that system.size_estimates isn't populated or that the number of splits computed by Beam is still to low for Cassandra to handle it. This setting allows to enforce a minimum number of splits in case Beam cannot compute it correctly.

withMinNumberOfSplits

public CassandraIO.Read<T> withMinNumberOfSplits(ValueProvider<java.lang.Integer> minNumberOfSplits)

It's possible that system.size_estimates isn't populated or that the number of splits computed by Beam is still to low for Cassandra to handle it. This setting allows to enforce a minimum number of splits in case Beam cannot compute it correctly.

withMapperFactoryFn

public CassandraIO.Read<T> withMapperFactoryFn(SerializableFunction<com.datastax.driver.core.Session,Mapper> mapperFactory)

A factory to create a specific Mapper for a given Cassandra Session. This is useful to provide mappers that don't rely in Cassandra annotated objects.

expand

public PCollection<T> 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<T>>