Package 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:
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:

  • Method Details

    • withConfiguration

      public HBaseIO.Read withConfiguration(org.apache.hadoop.conf.Configuration configuration)
      Reads from the HBase instance indicated by the* given configuration.

    • withTableId

      public HBaseIO.Read withTableId(String tableId)
      Reads from the specified table.

    • withScan

      public HBaseIO.Read withScan(org.apache.hadoop.hbase.client.Scan scan)
      Filters the rows read from HBase using the given* scan.

    • withFilter

      public HBaseIO.Read withFilter(org.apache.hadoop.hbase.filter.Filter filter)
      Filters the rows read from HBase using the given* row filter.

    • withKeyRange

      public HBaseIO.Read withKeyRange(ByteKeyRange keyRange)
      Reads only rows in the specified range.

    • withKeyRange

      public HBaseIO.Read withKeyRange(byte[] startRow, byte[] stopRow)
      Reads only rows in the specified range.

    • 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>>

    • 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:

    • getConfiguration

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

    • getTableId

      public String getTableId()

    • getScan

      public org.apache.hadoop.hbase.client.Scan getScan()

    • getKeyRange

      public ByteKeyRange getKeyRange()
      Returns the range of keys that will be read from the table.

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object