Package org.apache.beam.sdk.io.hbase

Class HBaseIO.Read

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData
    Enclosing class:
    HBaseIO
    public static class HBaseIO.Read
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,​org.apache.beam.sdk.values.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

        annotations, displayData, name, resourceHints

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(@Nullable java.lang.Object o)  
      org.apache.beam.sdk.values.PCollection<org.apache.hadoop.hbase.client.Result> expand​(org.apache.beam.sdk.values.PBegin input)  
      org.apache.hadoop.conf.Configuration getConfiguration()  
      org.apache.beam.sdk.io.range.ByteKeyRange getKeyRange()
      Returns the range of keys that will be read from the table.
      org.apache.hadoop.hbase.client.Scan getScan()  
      java.lang.String getTableId()  
      int hashCode()  
      void populateDisplayData​(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)  
      HBaseIO.Read withConfiguration​(org.apache.hadoop.conf.Configuration configuration)
      Reads from the HBase instance indicated by the* given configuration.
      HBaseIO.Read withFilter​(org.apache.hadoop.hbase.filter.Filter filter)
      Filters the rows read from HBase using the given* row filter.
      HBaseIO.Read withKeyRange​(byte[] startRow, byte[] stopRow)
      Reads only rows in the specified range.
      HBaseIO.Read withKeyRange​(org.apache.beam.sdk.io.range.ByteKeyRange keyRange)
      Reads only rows in the specified range.
      HBaseIO.Read withScan​(org.apache.hadoop.hbase.client.Scan scan)
      Filters the rows read from HBase using the given* scan.
      HBaseIO.Read withTableId​(java.lang.String tableId)
      Reads from the specified table.

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

        addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, toString, validate, validate

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • 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​(java.lang.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​(org.apache.beam.sdk.io.range.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 org.apache.beam.sdk.values.PCollection<org.apache.hadoop.hbase.client.Result> 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.hadoop.hbase.client.Result>>

      • populateDisplayData

        public void populateDisplayData​(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
        Specified by:
        populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData
        Overrides:
        populateDisplayData in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,​org.apache.beam.sdk.values.PCollection<org.apache.hadoop.hbase.client.Result>>

      • getConfiguration

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

      • getTableId

        public java.lang.String getTableId()

      • getScan

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

      • getKeyRange

        public org.apache.beam.sdk.io.range.ByteKeyRange getKeyRange()
        Returns the range of keys that will be read from the table.

      • equals

        public boolean equals​(@Nullable java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object