google-cloud-bigtable 2.6.0 → 2.10.1

data/lib/google/cloud/bigtable/row_filter/interleave_filter.rb

@@ -57,7 +57,7 @@ module Google
         #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
         #
         #   # Add filters to interleave filter
-        #   interleave.key("user-*")
+        #   interleave.key "user-*"
         #   interleave.sink
         #
         #   # OR
@@ -104,7 +104,7 @@ module Google
           #   # Add filters to chain filter
           #   chain.key("user-*").cells_per_row(5)
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.chain(chain)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.chain chain
           #
           def chain filter
             raise RowFilterError, "Filter type must be ChainFilter" unless filter.instance_of? ChainFilter
@@ -155,7 +155,7 @@ module Google
           #   # Add filters to an interleave filter.
           #   interleave.key("user-*").cells_per_column(3)
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.interleave(interleave)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.interleave interleave
           #
           def interleave filter
             raise RowFilterError, "Filter type must be InterleaveFilter" unless filter.instance_of? InterleaveFilter
@@ -182,15 +182,16 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")
+          #   predicate = Google::Cloud::Bigtable::RowFilter.key "user-*"
           #
-          #   label = Google::Cloud::Bigtable::RowFilter.label("user")
+          #   label = Google::Cloud::Bigtable::RowFilter.label "user"
           #   strip_value = Google::Cloud::Bigtable::RowFilter.strip_value
           #
-          #   condition_filter = Google::Cloud::Bigtable::RowFilter.
-          #     condition(predicate).on_match(label).otherwise(strip_value)
+          #   condition_filter = Google::Cloud::Bigtable::RowFilter.condition(predicate)
+          #                                                        .on_match(label)
+          #                                                        .otherwise(strip_value)
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.condition(condition_filter)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.condition condition_filter
           #
           def condition filter
             raise RowFilterError, "Filter type must be ConditionFilter" unless filter.instance_of? ConditionFilter
@@ -288,7 +289,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.key("user-*")
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.key "user-*"
           #
           def key regex
             add RowFilter.key(regex)
@@ -308,7 +309,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.sample(0.5)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.sample 0.5
           #
           def sample probability
             add RowFilter.sample(probability)
@@ -334,7 +335,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.family("cf-*")
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.family "cf-*"
           #
           def family regex
             add RowFilter.family(regex)
@@ -360,7 +361,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.qualifier("user-name*")
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.qualifier "user-name*"
           #
           def qualifier regex
             add RowFilter.qualifier(regex)
@@ -385,7 +386,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value("abc*")
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value "abc*"
           #
           def value regex
             add RowFilter.value(regex)
@@ -414,7 +415,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.label("user-detail")
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.label "user-detail"
           #
           def label value
             add RowFilter.label(value)
@@ -434,7 +435,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row_offset(3)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row_offset 3
           #
           def cells_per_row_offset offset
             add RowFilter.cells_per_row_offset(offset)
@@ -454,7 +455,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row(5)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row 5
           #
           def cells_per_row limit
             add RowFilter.cells_per_row(limit)
@@ -477,7 +478,7 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_column(5)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_column 5
           #
           def cells_per_column limit
             add RowFilter.cells_per_column(limit)
@@ -499,11 +500,11 @@ module Google
           # @example
           #   require "google/cloud/bigtable"
           #
-          #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
-          #   from = timestamp_micros - 300000000
+          #   timestamp_micros = (Time.now.to_f * 1_000_000).round(-3)
+          #   from = timestamp_micros - 300_000_000
           #   to = timestamp_micros
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.timestamp_range(from: from, to: to)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.timestamp_range from: from, to: to
           #
           def timestamp_range from: nil, to: nil
             add RowFilter.timestamp_range(from: from, to: to)
@@ -529,19 +530,19 @@ module Google
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
-          #   table = bigtable.table("my-instance", "my-table")
+          #   table = bigtable.table "my-instance", "my-table"
           #
           #   range = table.new_value_range.from("value-001").to("value-005")
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range(range)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range range
           #
           # @example Start exlusive to infinite end range.
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
-          #   table = bigtable.table("my-instance", "my-table")
+          #   table = bigtable.table "my-instance", "my-table"
           #
-          #   range = table.new_value_range.from("value-001", inclusive: false)
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range(range)
+          #   range = table.new_value_range.from "value-001", inclusive: false
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range range
           #
           def value_range range
             add RowFilter.value_range(range)
@@ -561,7 +562,7 @@ module Google
           #
           #   range = Google::Cloud::Bigtable::ColumnRange.new("cf").from("field0").to("field5")
           #
-          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.column_range(range)
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.column_range range
           #
           def column_range range
             add RowFilter.column_range(range)

data/lib/google/cloud/bigtable/row_filter.rb

@@ -127,10 +127,10 @@ module Google
       #   Google::Cloud::Bigtable::RowFilter.pass
       #
       #   # Key regex filter
-      #   Google::Cloud::Bigtable::RowFilter.key("user-*")
+      #   Google::Cloud::Bigtable::RowFilter.key "user-*"
       #
       #   # Cell limit filter
-      #   Google::Cloud::Bigtable::RowFilter.cells_per_row(10)
+      #   Google::Cloud::Bigtable::RowFilter.cells_per_row 10
       #
       module RowFilter
         # @private
@@ -166,7 +166,7 @@ module Google
         #   chain = Google::Cloud::Bigtable::RowFilter.chain
         #
         #   # Add filters to chain filter
-        #   chain.key("user-*")
+        #   chain.key "user-*"
         #   chain.strip_value
         #
         #   # OR
@@ -227,7 +227,7 @@ module Google
         #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
         #
         #   # Add filters to interleave filter
-        #   interleave.key("user-*")
+        #   interleave.key "user-*"
         #   interleave.sink
         #
         #   # OR
@@ -267,10 +267,10 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")
-        #   condition = Google::Cloud::Bigtable::RowFilter.condition(predicate)
+        #   predicate = Google::Cloud::Bigtable::RowFilter.key "user-*"
+        #   condition = Google::Cloud::Bigtable::RowFilter.condition predicate
         #
-        #   label = Google::Cloud::Bigtable::RowFilter.label("user")
+        #   label = Google::Cloud::Bigtable::RowFilter.label "user"
         #   strip_value = Google::Cloud::Bigtable::RowFilter.strip_value
         #
         #   # On match apply label, else strip cell values
@@ -366,7 +366,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.key("user-.*")
+        #   filter = Google::Cloud::Bigtable::RowFilter.key "user-.*"
         #
         def self.key regex
           SimpleFilter.new.key regex
@@ -385,7 +385,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.sample(0.5)
+        #   filter = Google::Cloud::Bigtable::RowFilter.sample 0.5
         #
         def self.sample probability
           SimpleFilter.new.sample probability
@@ -409,7 +409,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.family("cf-.*")
+        #   filter = Google::Cloud::Bigtable::RowFilter.family "cf-.*"
         #
         def self.family regex
           SimpleFilter.new.family regex
@@ -433,7 +433,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.qualifier("user-name.*")
+        #   filter = Google::Cloud::Bigtable::RowFilter.qualifier "user-name.*"
         #
         def self.qualifier regex
           SimpleFilter.new.qualifier regex
@@ -456,7 +456,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.value("abc.*")
+        #   filter = Google::Cloud::Bigtable::RowFilter.value "abc.*"
         #
         def self.value regex
           SimpleFilter.new.value regex
@@ -485,7 +485,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.label("user-detail")
+        #   filter = Google::Cloud::Bigtable::RowFilter.label "user-detail"
         #
         def self.label value
           SimpleFilter.new.label value
@@ -504,7 +504,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row_offset(3)
+        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row_offset 3
         #
         def self.cells_per_row_offset offset
           SimpleFilter.new.cells_per_row_offset offset
@@ -523,7 +523,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row(5)
+        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row 5
         #
         def self.cells_per_row limit
           SimpleFilter.new.cells_per_row limit
@@ -542,7 +542,7 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_column(5)
+        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_column 5
         #
         def self.cells_per_column limit
           SimpleFilter.new.cells_per_column limit
@@ -561,17 +561,17 @@ module Google
         # @example
         #   require "google/cloud/bigtable"
         #
-        #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
-        #   from = timestamp_micros - 300000000
+        #   timestamp_micros = (Time.now.to_f * 1_000_000).round(-3)
+        #   from = timestamp_micros - 300_000_000
         #   to = timestamp_micros
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.timestamp_range(from: from, to: to)
+        #   filter = Google::Cloud::Bigtable::RowFilter.timestamp_range from: from, to: to
         #
         #   # From to infinity
-        #   filter = Google::Cloud::Bigtable::RowFilter.timestamp_range(from: from)
+        #   filter = Google::Cloud::Bigtable::RowFilter.timestamp_range from: from
         #
         #   # From 0 value to `to`
-        #   filter = Google::Cloud::Bigtable::RowFilter.timestamp_range(to: to)
+        #   filter = Google::Cloud::Bigtable::RowFilter.timestamp_range to: to
         #
         def self.timestamp_range from: nil, to: nil
           SimpleFilter.new.timestamp_range from, to
@@ -597,19 +597,19 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_value_range.from("value-001", inclusive: false)
-        #   filter = Google::Cloud::Bigtable::RowFilter.value_range(range)
+        #   range = table.new_value_range.from "value-001", inclusive: false
+        #   filter = Google::Cloud::Bigtable::RowFilter.value_range range
         #
         # @example Start exclusive to infinite end range.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_value_range.from("value-001", inclusive: false)
-        #   filter = Google::Cloud::Bigtable::RowFilter.value_range(range)
+        #   range = table.new_value_range.from "value-001", inclusive: false
+        #   filter = Google::Cloud::Bigtable::RowFilter.value_range range
         #
         def self.value_range range
           SimpleFilter.new.value_range range
@@ -628,7 +628,7 @@ module Google
         #
         #   range = Google::Cloud::Bigtable::ColumnRange.new("cf").from("field0").to("field5")
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.column_range(range)
+        #   filter = Google::Cloud::Bigtable::RowFilter.column_range range
         #
         def self.column_range range
           SimpleFilter.new.column_range range

data/lib/google/cloud/bigtable/row_range.rb

@@ -30,7 +30,7 @@ module Google
       #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
-      #   table = bigtable.table("my-instance", "my-table")
+      #   table = bigtable.table "my-instance", "my-table"
       #
       #   # Range that includes all row keys including "user-001" to "user-005"
       #   table.new_row_range.from("user-001").to("user-005", inclusive: true)
@@ -39,19 +39,19 @@ module Google
       #   table.new_row_range.from("user-001").to("user-010")
       #
       #   # Range that includes all row keys including "user-001" up until end of the row keys.
-      #   table.new_row_range.from("user-001")
+      #   table.new_row_range.from "user-001"
       #
       #   # Range that includes all row keys exclusive "user-001" up until end of the row keys.
-      #   table.new_row_range.from("user-001", inclusive: false)
+      #   table.new_row_range.from "user-001", inclusive: false
       #
       #   # Range with unbounded from and the exclusive end "user-010"
-      #   table.new_row_range.to("user-010")
+      #   table.new_row_range.to "user-010"
       #
       #   # Range that includes all row keys including from and end row keys "user-001", "user-010"
-      #   table.new_row_range.between("user-001", "user-010")
+      #   table.new_row_range.between "user-001", "user-010"
       #
       #   # Range that includes all row keys including "user-001" up until "user-010"
-      #   table.new_row_range.of("user-001", "user-010")
+      #   table.new_row_range.of "user-001", "user-010"
       #
       class RowRange
         # @private
@@ -72,17 +72,17 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_row_range.from("key-001")
+        #   range = table.new_row_range.from "key-001"
         #
         # @example Exclusive lower bound.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_row_range.from("key-001", inclusive: false)
+        #   range = table.new_row_range.from "key-001", inclusive: false
         #
         def from key, inclusive: true
           if inclusive
@@ -105,17 +105,17 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_row_range.to("key-001", inclusive: true)
+        #   range = table.new_row_range.to "key-001", inclusive: true
         #
         # @example Exclusive upper bound.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_row_range.to("key-001")
+        #   range = table.new_row_range.to "key-001"
         #
         def to key, inclusive: false
           if inclusive
@@ -138,9 +138,9 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_row_range.between("key-001", "key-010")
+        #   range = table.new_row_range.between "key-001", "key-010"
         #
         def between from_key, to_key
           from(from_key).to(to_key, inclusive: true)
@@ -158,9 +158,9 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   range = table.new_row_range.of("key-001", "key-010")
+        #   range = table.new_row_range.of "key-001", "key-010"
         #
         def of from_key, to_key
           from(from_key).to(to_key)

data/lib/google/cloud/bigtable/rows_reader.rb

@@ -75,6 +75,7 @@ module Google
         #   Array of row or yield block for each processed row.
         #
         def read rows: nil, filter: nil, rows_limit: nil
+          @rows_count = 0
           response = @table.service.read_rows(
             @table.instance_id,
             @table.table_id,
@@ -116,40 +117,54 @@ module Google
         #   If not specified, reads from all rows.
         #   A hash of the same form as `Google::Cloud::Bigtable::V2::RowSet`
         #   can also be provided.
-        # @return [Integer, Google::Cloud::Bigtable::V2::RowSet]
+        # @return ResumptionOption
         #
         def retry_options rows_limit, row_set
-          return [rows_limit, row_set] unless last_key
+          return ResumptionOption.new false, rows_limit, row_set unless last_key
+
+          # Check if we've already read read rows_limit number of rows.
+          # If true, mark ResumptionOption is_complete to true.
+          return ResumptionOption.new true, nil, nil if rows_limit && rows_limit == @rows_count
 
-          # 1. Reduce the limit by the number of already returned responses.
+          # Reduce the limit by the number of already returned responses.
           rows_limit -= @rows_count if rows_limit
 
-          # 2. Remove ranges that have already been read, and reduce ranges that
+          reset_row_set rows_limit, row_set
+        end
+
+        ##
+        # Calculate the new row_set for the retry request
+        # @param rows_limit [Integer]
+        #    the updated rows_limit
+        # @param row_set [Google::Cloud::Bigtable::V2::RowSet]
+        #    original row_set
+        # @return ResumptionOption
+        def reset_row_set rows_limit, row_set
+          # 1. Remove ranges that have already been read, and reduce ranges that
           # include the last read rows
           if last_key
-            delete_indexes = []
-
-            row_set.row_ranges.each_with_index do |range, i|
-              if end_key_read? range
-                delete_indexes << i
-              elsif start_key_read? range
+            row_set.row_ranges.reject! { |r| end_key_read? r }
+            row_set.row_ranges.each do |range|
+              if start_key_read? range
                 range.start_key_open = last_key
               end
             end
-
-            delete_indexes.each { |i| row_set.row_ranges.delete_at i }
-          end
-
-          if row_set.row_ranges.empty?
-            row_set.row_ranges <<
-              Google::Cloud::Bigtable::V2::RowRange.new(start_key_open: last_key)
           end
 
-          # 3. Remove all individual keys before and up to the last read key
+          # 2. Remove all individual keys before and up to the last read key
           row_set.row_keys.select! { |k| k > last_key }
 
+          # 3. In read_operations, we always add an empty row_range if row_ranges and
+          # row_keys are not defined. So if both row_ranges and row_keys are empty,
+          # it means that we've already read all the ranges and keys, set ResumptionOption
+          # is_complete to true to indicate that this read is successful.
+          if last_key && row_set.row_ranges.empty? && row_set.row_keys.empty?
+            return ResumptionOption.new true, nil, nil
+          end
+
           @chunk_processor.reset_to_new_row
-          [rows_limit, row_set]
+
+          ResumptionOption.new false, rows_limit, row_set
         end
 
         ##
@@ -170,13 +185,14 @@ module Google
         # @return [Boolean]
         #
         def start_key_read? range
-          start_key = if range.start_key_closed.empty?
-                        range.start_key_open
-                      else
-                        range.start_key_closed
-                      end
-
-          start_key.empty? || last_key >= start_key
+          if !range.start_key_closed.empty?
+            last_key >= range.start_key_closed
+          elsif !range.start_key_open.empty?
+            last_key > range.start_key_closed
+          else
+            # start is unbounded
+            true
+          end
         end
 
         ##
@@ -186,13 +202,42 @@ module Google
         # @return [Boolean]
         #
         def end_key_read? range
-          end_key = if range.end_key_closed.empty?
-                      range.end_key_open
-                    else
-                      range.end_key_closed
-                    end
+          if !range.end_key_closed.empty?
+            range.end_key_closed <= last_key
+          elsif !range.end_key_open.empty?
+            range.end_key_open <= last_key
+          else
+            # end is unbounded
+            false
+          end
+        end
+      end
 
-          end_key && end_key <= last_key
+      # @private
+      # ResumptionOption
+      # Helper class returned by retry_options
+      class ResumptionOption
+        # @private
+        # Creates a ResumptionOption instance
+        # @param is_complete [Boolean]
+        #    marks if the current read is complete
+        # @param rows_limit [Integer]
+        #    limit of the retry request
+        # @param row_set [Google::Cloud::Bigtable::V2::RowSet]
+        #    row_set of the retry request
+        def initialize is_complete, rows_limit, row_set
+          @is_complete = is_complete
+          @rows_limit = rows_limit
+          @row_set = row_set
+        end
+
+        attr_reader :rows_limit
+        attr_reader :row_set
+
+        ##
+        # returns if this operation should be retried
+        def complete?
+          @is_complete
         end
       end
     end

data/lib/google/cloud/bigtable/sample_row_key.rb

@@ -42,7 +42,7 @@ module Google
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
-      #   table = bigtable.table("my-instance", "my-table")
+      #   table = bigtable.table "my-instance", "my-table"
       #
       #   table.sample_row_keys.each do |r|
       #     p r