org.apache.beam.sdk.io.hbase

Class HBaseIO.Read

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<org.apache.hadoop.hbase.client.Result>>

org.apache.beam.sdk.io.hbase.HBaseIO.Read

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

HBaseIO

public static class HBaseIO.Read
extends PTransform<PBegin,PCollection<org.apache.hadoop.hbase.client.Result>>

A PTransform that reads from HBase. See the class-level Javadoc on HBaseIO for more information.

See Also:

HBaseIO, Serialized Form

Field Summary

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

name

Method Summary

Modifier and Type	Method and Description
PCollection<org.apache.hadoop.hbase.client.Result>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
org.apache.hadoop.conf.Configuration	getConfiguration()
ByteKeyRange	getKeyRange() Returns the range of keys that will be read from the table.
java.lang.String	getTableId()
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
HBaseIO.Read	withConfiguration(org.apache.hadoop.conf.Configuration configuration) Returns a new HBaseIO.Read that will read from the HBase instance indicated by the given configuration.
HBaseIO.Read	withFilter(org.apache.hadoop.hbase.filter.Filter filter) Returns a new HBaseIO.Read that will filter the rows read from HBase using the given row filter.
HBaseIO.Read	withKeyRange(byte[] startRow, byte[] stopRow) Returns a new HBaseIO.Read that will read only rows in the specified range.
HBaseIO.Read	withKeyRange(ByteKeyRange keyRange) Returns a new HBaseIO.Read that will read only rows in the specified range.
HBaseIO.Read	withScan(org.apache.hadoop.hbase.client.Scan scan) Returns a new HBaseIO.Read that will filter the rows read from HBase using the given scan.
HBaseIO.Read	withTableId(java.lang.String tableId) Returns a new HBaseIO.Read that will read from the specified table.

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

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

Methods inherited from class java.lang.Object

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

Method Detail

withConfiguration

public HBaseIO.Read withConfiguration(org.apache.hadoop.conf.Configuration configuration)

Returns a new HBaseIO.Read that will read from the HBase instance indicated by the given configuration.

withTableId

public HBaseIO.Read withTableId(java.lang.String tableId)

Returns a new HBaseIO.Read that will read from the specified table.

Does not modify this object.

withScan

public HBaseIO.Read withScan(org.apache.hadoop.hbase.client.Scan scan)

Returns a new HBaseIO.Read that will filter the rows read from HBase using the given scan.

Does not modify this object.

withFilter

public HBaseIO.Read withFilter(org.apache.hadoop.hbase.filter.Filter filter)

Returns a new HBaseIO.Read that will filter the rows read from HBase using the given row filter.

Does not modify this object.

withKeyRange

public HBaseIO.Read withKeyRange(ByteKeyRange keyRange)

Returns a new HBaseIO.Read that will read only rows in the specified range.

Does not modify this object.

withKeyRange

public HBaseIO.Read withKeyRange(byte[] startRow,
                                 byte[] stopRow)

Returns a new HBaseIO.Read that will read only rows in the specified range.

Does not modify this object.

expand

public PCollection<org.apache.hadoop.hbase.client.Result> 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<org.apache.hadoop.hbase.client.Result>>

validate

public void validate(PipelineOptions options)

Description copied from class: PTransform

Called before running the Pipeline to verify this transform is fully and correctly specified.

By default, does nothing.

Overrides:

validate in class PTransform<PBegin,PCollection<org.apache.hadoop.hbase.client.Result>>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PBegin,PCollection<org.apache.hadoop.hbase.client.Result>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

getTableId

public java.lang.String getTableId()

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

getKeyRange

public ByteKeyRange getKeyRange()

Returns the range of keys that will be read from the table.