org.apache.beam.sdk.io.hadoop.format

Class HadoopFormatIO.Read<K,V>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K,V>>>

org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.Read<K,V>

Type Parameters:

K - Type of keys to be read.

V - Type of values to be read.

All Implemented Interfaces:

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

Enclosing class:

HadoopFormatIO

public abstract static class HadoopFormatIO.Read<K,V>
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K,V>>>

A PTransform that reads from any data source which implements Hadoop InputFormat. For e.g. Cassandra, Elasticsearch, HBase, Redis, Postgres, etc. See the class-level Javadoc on HadoopFormatIO for more information.

See Also:

HadoopFormatIO, Serialized Form

Field Summary

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

annotations, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K,V>>	expand(org.apache.beam.sdk.values.PBegin input)
abstract @Nullable org.apache.beam.sdk.io.hadoop.SerializableConfiguration	getConfiguration()
<T> org.apache.beam.sdk.coders.Coder<T>	getDefaultCoder(org.apache.beam.sdk.values.TypeDescriptor<?> typeDesc, org.apache.beam.sdk.coders.CoderRegistry coderRegistry) Returns the default coder for a given type descriptor.
abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<?>	getinputFormatClass()
abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<?>	getinputFormatKeyClass()
abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<?>	getinputFormatValueClass()
abstract @Nullable org.apache.beam.sdk.coders.Coder<K>	getKeyCoder()
abstract @Nullable org.apache.beam.sdk.transforms.SimpleFunction<?,K>	getKeyTranslationFunction()
abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<K>	getKeyTypeDescriptor()
abstract @Nullable java.lang.Boolean	getSkipKeyClone()
abstract @Nullable java.lang.Boolean	getSkipValueClone()
abstract @Nullable org.apache.beam.sdk.coders.Coder<V>	getValueCoder()
abstract @Nullable org.apache.beam.sdk.transforms.SimpleFunction<?,V>	getValueTranslationFunction()
abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<V>	getValueTypeDescriptor()
abstract org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.Read.Builder<K,V>	toBuilder()
void	validateTransform() Validates construction of this transform.
HadoopFormatIO.Read<K,V>	withConfiguration(org.apache.hadoop.conf.Configuration configuration) Reads from the source using the options provided by the given configuration.
HadoopFormatIO.Read<K,V>	withKeyTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,K> function) Transforms the keys read from the source using the given key translation function.
HadoopFormatIO.Read<K,V>	withKeyTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,K> function, org.apache.beam.sdk.coders.Coder<K> coder) Transforms the keys read from the source using the given key translation function.
HadoopFormatIO.Read<K,V>	withSkipKeyClone(boolean value) Determines if key clone should be skipped or not (default is 'false').
HadoopFormatIO.Read<K,V>	withSkipValueClone(boolean value) Determines if value clone should be skipped or not (default is 'false').
HadoopFormatIO.Read<K,V>	withValueTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,V> function) Transforms the values read from the source using the given value translation function.
HadoopFormatIO.Read<K,V>	withValueTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,V> function, org.apache.beam.sdk.coders.Coder<V> coder) Transforms the values read from the source using the given value translation function.

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate, 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

getConfiguration

public abstract @Nullable org.apache.beam.sdk.io.hadoop.SerializableConfiguration getConfiguration()

getKeyTranslationFunction

public abstract @Nullable org.apache.beam.sdk.transforms.SimpleFunction<?,K> getKeyTranslationFunction()

getValueTranslationFunction

public abstract @Nullable org.apache.beam.sdk.transforms.SimpleFunction<?,V> getValueTranslationFunction()

getKeyTypeDescriptor

public abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<K> getKeyTypeDescriptor()

getKeyCoder

public abstract @Nullable org.apache.beam.sdk.coders.Coder<K> getKeyCoder()

getValueTypeDescriptor

public abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<V> getValueTypeDescriptor()

getValueCoder

public abstract @Nullable org.apache.beam.sdk.coders.Coder<V> getValueCoder()

getSkipKeyClone

public abstract @Nullable java.lang.Boolean getSkipKeyClone()

getSkipValueClone

public abstract @Nullable java.lang.Boolean getSkipValueClone()

getinputFormatClass

public abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<?> getinputFormatClass()

getinputFormatKeyClass

public abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<?> getinputFormatKeyClass()

getinputFormatValueClass

public abstract @Nullable org.apache.beam.sdk.values.TypeDescriptor<?> getinputFormatValueClass()

toBuilder

public abstract org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.Read.Builder<K,V> toBuilder()

withConfiguration

public HadoopFormatIO.Read<K,V> withConfiguration(org.apache.hadoop.conf.Configuration configuration)

Reads from the source using the options provided by the given configuration.

withKeyTranslation

public HadoopFormatIO.Read<K,V> withKeyTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,K> function)

Transforms the keys read from the source using the given key translation function.

withKeyTranslation

public HadoopFormatIO.Read<K,V> withKeyTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,K> function,
                                                   org.apache.beam.sdk.coders.Coder<K> coder)

Transforms the keys read from the source using the given key translation function.

withValueTranslation

public HadoopFormatIO.Read<K,V> withValueTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,V> function)

Transforms the values read from the source using the given value translation function.

withValueTranslation

public HadoopFormatIO.Read<K,V> withValueTranslation(org.apache.beam.sdk.transforms.SimpleFunction<?,V> function,
                                                     org.apache.beam.sdk.coders.Coder<V> coder)

Transforms the values read from the source using the given value translation function.

withSkipKeyClone

public HadoopFormatIO.Read<K,V> withSkipKeyClone(boolean value)

Determines if key clone should be skipped or not (default is 'false').

withSkipValueClone

public HadoopFormatIO.Read<K,V> withSkipValueClone(boolean value)

Determines if value clone should be skipped or not (default is 'false').

expand

public org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<K,V>> 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<org.apache.beam.sdk.values.KV<K,V>>>

validateTransform

public void validateTransform()

Validates construction of this transform.

getDefaultCoder

public <T> org.apache.beam.sdk.coders.Coder<T> getDefaultCoder(org.apache.beam.sdk.values.TypeDescriptor<?> typeDesc,
                                                               org.apache.beam.sdk.coders.CoderRegistry coderRegistry)

Returns the default coder for a given type descriptor. Coder Registry is queried for correct coder, if not found in Coder Registry, then check if the type descriptor provided is of type Writable, then WritableCoder is returned, else exception is thrown "Cannot find coder".