google-cloud-bigtable 0.6.1 → 1.0.1

data/lib/google/cloud/bigtable/table/cluster_state.rb

@@ -19,6 +19,7 @@ module Google
   module Cloud
     module Bigtable
       class Table
+        ##
         # Table::ClusterState is the state of a table's data in a particular cluster.
         class ClusterState
           attr_reader :cluster_name
@@ -31,47 +32,57 @@ module Google
             @cluster_name = cluster_name
           end
 
+          ##
           # The state of replication for the table in this cluster.
           #   Valid values are:
           #   * `:INITIALIZING` - The cluster was recently created.
           #   * `:PLANNED_MAINTENANCE` - The table is temporarily unable to serve.
           #   * `:UNPLANNED_MAINTENANCE` - The table is temporarily unable to serve.
           #   * `:READY` - The table can serve.
-          # @return [Symbol]
+          #
+          # @return [Symbol] The state of replication.
           #
           def replication_state
             @grpc.replication_state
           end
 
+          ##
           # The cluster was recently created, and the table must finish copying
           # over pre-existing data from other clusters before it can begin
           # receiving live replication updates and serving.
-          # @return [Boolean]
+          #
+          # @return [Boolean] `true` if the cluster is initializing.
           #
           def initializing?
             replication_state == :INITIALIZING
           end
 
+          ##
           # The table is temporarily unable to serve
           # requests from this cluster due to planned internal maintenance.
-          # @return [Boolean]
+          #
+          # @return [Boolean] `true` if the cluster is in planned maintenance.
           #
           def planned_maintenance?
             replication_state == :PLANNED_MAINTENANCE
           end
 
+          ##
           # The table is temporarily unable to serve requests from this
           # cluster due to unplanned or emergency maintenance.
-          # @return [Boolean]
+          #
+          # @return [Boolean] `true` if the cluster is in unplanned maintenance.
           #
           def unplanned_maintenance?
             replication_state == :UNPLANNED_MAINTENANCE
           end
 
+          ##
           # The table can serve requests from this cluster.
           # Depending on replication delay, reads may not immediately
           # reflect the state of the table in other clusters.
-          # @return [Boolean]
+          #
+          # @return [Boolean] `true` if the cluster is ready.
           #
           def ready?
             replication_state == :READY
@@ -84,7 +95,7 @@ module Google
           # @return [Google::Cloud::Bigtable::Table::ClusterState]
           #
           def self.from_grpc grpc, cluster_name
-            new(grpc, cluster_name)
+            new grpc, cluster_name
           end
         end
       end

data/lib/google/cloud/bigtable/table/list.rb

@@ -19,8 +19,10 @@ module Google
   module Cloud
     module Bigtable
       class Table
+        ##
         # Table::List is a special-case array with additional
         # values.
+        #
         class List < DelegateClass(::Array)
           # @private
           # The gRPC Service object.
@@ -33,9 +35,10 @@ module Google
           # @private
           # Creates a new Table::List with an array of table instances.
           def initialize arr = []
-            super(arr)
+            super arr
           end
 
+          ##
           # Whether there is a next page of tables.
           #
           # @return [Boolean]
@@ -49,10 +52,12 @@ module Google
           #   if tables.next?
           #     next_tables = tables.next
           #   end
+          #
           def next?
             grpc.next_page?
           end
 
+          ##
           # Retrieves the next page of tables.
           #
           # @return [Table::List] The list of table instances.
@@ -66,14 +71,16 @@ module Google
           #   if tables.next?
           #     next_tables = tables.next
           #   end
+          #
           def next
             ensure_grpc!
 
             return nil unless next?
             grpc.next_page
-            self.class.from_grpc(grpc, service)
+            self.class.from_grpc grpc, service
           end
 
+          ##
           # Retrieves remaining results by repeatedly invoking {#next} until
           # {#next?} returns `false`. Calls the given block once for each
           # result, which is passed as the argument to the block.
@@ -85,16 +92,16 @@ module Google
           # over the results returned by a single API call). Use with caution.
           #
           # @yield [table] The block for accessing each table instance.
-          # @yieldparam [Table] instance The table instance object.
+          # @yieldparam [Table] table The table instance object.
           #
           # @return [Enumerator]
           #
-          # @example Iterating each instance by passing a block:
+          # @example Iterating each table by passing a block:
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   bigtable.tables("instance-id").all do |table|
+          #   bigtable.tables("my-instance").all do |table|
           #     puts table.table_id
           #   end
           #
@@ -103,19 +110,19 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   all_table_ids = bigtable.tables("instance-id").all.map do |table|
+          #   all_table_ids = bigtable.tables("my-instance").all.map do |table|
           #     puts table.table_id
           #   end
           #
           def all
-            return enum_for(:all) unless block_given?
+            return enum_for :all unless block_given?
 
             results = self
             loop do
               results.each { |r| yield r }
               break unless next?
               grpc.next_page
-              results = self.class.from_grpc(grpc, service)
+              results = self.class.from_grpc grpc, service
             end
           end
 
@@ -124,7 +131,7 @@ module Google
           #
           def self.from_grpc grpc, service
             tables = List.new(Array(grpc.response.tables).map do |table|
-              Table.from_grpc(table, service, view: :NAME_ONLY)
+              Table.from_grpc table, service, view: :NAME_ONLY
             end)
             tables.grpc = grpc
             tables.service = service

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

@@ -21,7 +21,7 @@ module Google
       # rubocop:disable LineLength
 
       ##
-      # # Ruby Client for Cloud Bigtable API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
+      # # Ruby Client for Cloud Bigtable API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
       #
       # [Cloud Bigtable API][Product Documentation]:
       # API for reading and writing the contents of Bigtables associated with a

data/lib/google/cloud/bigtable/v2/bigtable_client.rb

@@ -250,7 +250,7 @@ module Google
           # ReadRowsResponse documentation for details.
           #
           # @param table_name [String]
-          #   The unique name of the table from which to read.
+          #   Required. The unique name of the table from which to read.
           #   Values are of the form
           #   `projects/<project>/instances/<instance>/tables/<table>`.
           # @param app_profile_id [String]
@@ -308,7 +308,7 @@ module Google
           # mapreduces.
           #
           # @param table_name [String]
-          #   The unique name of the table from which to sample row keys.
+          #   Required. The unique name of the table from which to sample row keys.
           #   Values are of the form
           #   `projects/<project>/instances/<instance>/tables/<table>`.
           # @param app_profile_id [String]
@@ -346,13 +346,13 @@ module Google
           # unchanged unless explicitly changed by `mutation`.
           #
           # @param table_name [String]
-          #   The unique name of the table to which the mutation should be applied.
+          #   Required. The unique name of the table to which the mutation should be applied.
           #   Values are of the form
           #   `projects/<project>/instances/<instance>/tables/<table>`.
           # @param row_key [String]
-          #   The key of the row to which the mutation should be applied.
+          #   Required. The key of the row to which the mutation should be applied.
           # @param mutations [Array<Google::Bigtable::V2::Mutation | Hash>]
-          #   Changes to be atomically applied to the specified row. Entries are applied
+          #   Required. Changes to be atomically applied to the specified row. Entries are applied
           #   in order, meaning that earlier mutations can be masked by later ones.
           #   Must contain at least one entry and at most 100000.
           #   A hash of the same form as `Google::Bigtable::V2::Mutation`
@@ -403,9 +403,9 @@ module Google
           # atomically.
           #
           # @param table_name [String]
-          #   The unique name of the table to which the mutations should be applied.
+          #   Required. The unique name of the table to which the mutations should be applied.
           # @param entries [Array<Google::Bigtable::V2::MutateRowsRequest::Entry | Hash>]
-          #   The row keys and corresponding mutations to be applied in bulk.
+          #   Required. The row keys and corresponding mutations to be applied in bulk.
           #   Each entry is applied as an atomic mutation, but the entries may be
           #   applied in arbitrary order (even between entries for the same row).
           #   At least one entry must be specified, and in total the entries can
@@ -451,12 +451,12 @@ module Google
           # Mutates a row atomically based on the output of a predicate Reader filter.
           #
           # @param table_name [String]
-          #   The unique name of the table to which the conditional mutation should be
+          #   Required. The unique name of the table to which the conditional mutation should be
           #   applied.
           #   Values are of the form
           #   `projects/<project>/instances/<instance>/tables/<table>`.
           # @param row_key [String]
-          #   The key of the row to which the conditional mutation should be applied.
+          #   Required. The key of the row to which the conditional mutation should be applied.
           # @param app_profile_id [String]
           #   This value specifies routing for replication. If not specified, the
           #   "default" application profile will be used.
@@ -529,14 +529,14 @@ module Google
           # time. The method returns the new contents of all modified cells.
           #
           # @param table_name [String]
-          #   The unique name of the table to which the read/modify/write rules should be
+          #   Required. The unique name of the table to which the read/modify/write rules should be
           #   applied.
           #   Values are of the form
           #   `projects/<project>/instances/<instance>/tables/<table>`.
           # @param row_key [String]
-          #   The key of the row to which the read/modify/write rules should be applied.
+          #   Required. The key of the row to which the read/modify/write rules should be applied.
           # @param rules [Array<Google::Bigtable::V2::ReadModifyWriteRule | Hash>]
-          #   Rules specifying how the specified row's contents are to be transformed
+          #   Required. Rules specifying how the specified row's contents are to be transformed
           #   into writes. Entries are applied in order, meaning that earlier rules will
           #   affect the results of later ones.
           #   A hash of the same form as `Google::Bigtable::V2::ReadModifyWriteRule`

data/lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb

@@ -19,7 +19,7 @@ module Google
       # Request message for Bigtable.ReadRows.
       # @!attribute [rw] table_name
       #   @return [String]
-      #     The unique name of the table from which to read.
+      #     Required. The unique name of the table from which to read.
       #     Values are of the form
       #     `projects/<project>/instances/<instance>/tables/<table>`.
       # @!attribute [rw] app_profile_id
@@ -42,6 +42,7 @@ module Google
       # Response message for Bigtable.ReadRows.
       # @!attribute [rw] chunks
       #   @return [Array<Google::Bigtable::V2::ReadRowsResponse::CellChunk>]
+      #     A collection of a row's contents as part of the read request.
       # @!attribute [rw] last_scanned_row_key
       #   @return [String]
       #     Optionally the server might return the row key of the last row it
@@ -117,7 +118,7 @@ module Google
       # Request message for Bigtable.SampleRowKeys.
       # @!attribute [rw] table_name
       #   @return [String]
-      #     The unique name of the table from which to sample row keys.
+      #     Required. The unique name of the table from which to sample row keys.
       #     Values are of the form
       #     `projects/<project>/instances/<instance>/tables/<table>`.
       # @!attribute [rw] app_profile_id
@@ -147,7 +148,7 @@ module Google
       # Request message for Bigtable.MutateRow.
       # @!attribute [rw] table_name
       #   @return [String]
-      #     The unique name of the table to which the mutation should be applied.
+      #     Required. The unique name of the table to which the mutation should be applied.
       #     Values are of the form
       #     `projects/<project>/instances/<instance>/tables/<table>`.
       # @!attribute [rw] app_profile_id
@@ -156,10 +157,10 @@ module Google
       #     "default" application profile will be used.
       # @!attribute [rw] row_key
       #   @return [String]
-      #     The key of the row to which the mutation should be applied.
+      #     Required. The key of the row to which the mutation should be applied.
       # @!attribute [rw] mutations
       #   @return [Array<Google::Bigtable::V2::Mutation>]
-      #     Changes to be atomically applied to the specified row. Entries are applied
+      #     Required. Changes to be atomically applied to the specified row. Entries are applied
       #     in order, meaning that earlier mutations can be masked by later ones.
       #     Must contain at least one entry and at most 100000.
       class MutateRowRequest; end
@@ -170,25 +171,26 @@ module Google
       # Request message for BigtableService.MutateRows.
       # @!attribute [rw] table_name
       #   @return [String]
-      #     The unique name of the table to which the mutations should be applied.
+      #     Required. The unique name of the table to which the mutations should be applied.
       # @!attribute [rw] app_profile_id
       #   @return [String]
       #     This value specifies routing for replication. If not specified, the
       #     "default" application profile will be used.
       # @!attribute [rw] entries
       #   @return [Array<Google::Bigtable::V2::MutateRowsRequest::Entry>]
-      #     The row keys and corresponding mutations to be applied in bulk.
+      #     Required. The row keys and corresponding mutations to be applied in bulk.
       #     Each entry is applied as an atomic mutation, but the entries may be
       #     applied in arbitrary order (even between entries for the same row).
       #     At least one entry must be specified, and in total the entries can
       #     contain at most 100000 mutations.
       class MutateRowsRequest
+        # A mutation for a given row.
         # @!attribute [rw] row_key
         #   @return [String]
         #     The key of the row to which the `mutations` should be applied.
         # @!attribute [rw] mutations
         #   @return [Array<Google::Bigtable::V2::Mutation>]
-        #     Changes to be atomically applied to the specified row. Mutations are
+        #     Required. Changes to be atomically applied to the specified row. Mutations are
         #     applied in order, meaning that earlier mutations can be masked by
         #     later ones.
         #     You must specify at least one mutation.
@@ -200,6 +202,7 @@ module Google
       #   @return [Array<Google::Bigtable::V2::MutateRowsResponse::Entry>]
       #     One or more results for Entries from the batch request.
       class MutateRowsResponse
+        # The result of applying a passed mutation in the original request.
         # @!attribute [rw] index
         #   @return [Integer]
         #     The index into the original request's `entries` list of the Entry
@@ -216,7 +219,7 @@ module Google
       # Request message for Bigtable.CheckAndMutateRow.
       # @!attribute [rw] table_name
       #   @return [String]
-      #     The unique name of the table to which the conditional mutation should be
+      #     Required. The unique name of the table to which the conditional mutation should be
       #     applied.
       #     Values are of the form
       #     `projects/<project>/instances/<instance>/tables/<table>`.
@@ -226,7 +229,7 @@ module Google
       #     "default" application profile will be used.
       # @!attribute [rw] row_key
       #   @return [String]
-      #     The key of the row to which the conditional mutation should be applied.
+      #     Required. The key of the row to which the conditional mutation should be applied.
       # @!attribute [rw] predicate_filter
       #   @return [Google::Bigtable::V2::RowFilter]
       #     The filter to be applied to the contents of the specified row. Depending
@@ -259,7 +262,7 @@ module Google
       # Request message for Bigtable.ReadModifyWriteRow.
       # @!attribute [rw] table_name
       #   @return [String]
-      #     The unique name of the table to which the read/modify/write rules should be
+      #     Required. The unique name of the table to which the read/modify/write rules should be
       #     applied.
       #     Values are of the form
       #     `projects/<project>/instances/<instance>/tables/<table>`.
@@ -269,10 +272,10 @@ module Google
       #     "default" application profile will be used.
       # @!attribute [rw] row_key
       #   @return [String]
-      #     The key of the row to which the read/modify/write rules should be applied.
+      #     Required. The key of the row to which the read/modify/write rules should be applied.
       # @!attribute [rw] rules
       #   @return [Array<Google::Bigtable::V2::ReadModifyWriteRule>]
-      #     Rules specifying how the specified row's contents are to be transformed
+      #     Required. Rules specifying how the specified row's contents are to be transformed
       #     into writes. Entries are applied in order, meaning that earlier rules will
       #     affect the results of later ones.
       class ReadModifyWriteRowRequest; end

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

@@ -18,6 +18,7 @@
 module Google
   module Cloud
     module Bigtable
+      ##
       # # ValueRange
       #
       # Specifies a contiguous range of string values.
@@ -33,7 +34,7 @@ module Google
       #   bigtable = Google::Cloud::Bigtable.new
       #   table = bigtable.table("my-instance", "my-table")
       #
-      #   # Range that includes all row keys including "value-001" to "value-005" excluding
+      #   # Range that includes all row keys including "value-001" to "value-005" excluding.
       #   table.new_value_range.from("value-001").to("value-005")
       #
       #   # Range that includes all row keys including "value-001" up to inclusive "value-010".
@@ -45,13 +46,13 @@ module Google
       #   # Range that includes all row keys exclusive "value-001" up until end of the row keys.
       #   table.new_value_range.from("value-001", inclusive: false)
       #
-      #   # Range with unbounded from and the exclusive end "value-100"
+      #   # Range with unbounded from and the exclusive end "value-100".
       #   table.new_value_range.to("value-100")
       #
-      #   # Range that includes all row keys including from and end row keys "value-001", "value-100"
+      #   # Range that includes all row keys including from and end row keys "value-001", "value-100".
       #   table.new_value_range.between("value-001", "value-100")
       #
-      #   # Range that includes all row keys including "value-001" up until "value-100"
+      #   # Range that includes all row keys including "value-001" up until "value-100".
       #   table.new_value_range.of("value-001", "value-100")
       #
       class ValueRange
@@ -61,11 +62,12 @@ module Google
           @grpc = Google::Bigtable::V2::ValueRange.new
         end
 
+        ##
         # Sets the row range with the lower bound.
         #
-        # @param value [String] value. Required
-        # @param inclusive [String] Inclusive/Exclusive lower bound.
-        #   Default it is an inclusive lower bound.
+        # @param value [String] The value. Required.
+        # @param inclusive [Boolean] Whether the value is an inclusive or
+        #   exclusive lower bound. Default is `true`, an inclusive lower bound.
         # @return [Google::Cloud::Bigtable::ValueRange]
         #
         # @example Inclusive lower bound.
@@ -93,11 +95,12 @@ module Google
           self
         end
 
+        ##
         # Sets the value range with upper bound.
         #
         # @param value [String] value. Required
-        # @param inclusive [String] Inclusive/Exclusive upper bound.
-        #   Default it is an exclusive upper bound.
+        # @param inclusive [Boolean] Whether the value is an inclusive or
+        #   exclusive lower bound. Default is `false`, an exclusive lower bound.
         # @return [Google::Cloud::Bigtable::ValueRange]
         #
         # @example Inclusive upper bound.
@@ -125,12 +128,13 @@ module Google
           self
         end
 
-        # Sets the value range with the inclusive lower and upper bound.
+        ##
+        # Sets the value range with inclusive lower and upper bounds.
         #
         # @param from_value [String] Inclusive from value. Required
-        # @param to_value [String] Inclusive end value. Required
+        # @param to_value [String] Inclusive to value. Required
         # @return [Google::Cloud::Bigtable::ValueRange]
-        #   Range with inclusive from and end value.
+        #   Range with inclusive from and to values.
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -144,11 +148,13 @@ module Google
           from(from_value).to(to_value, inclusive: true)
         end
 
-        # Set value range with the inclusive lower and the exclusive upper bound.
+        ##
+        # Set value range with an inclusive lower bound and an exclusive upper bound.
         #
         # @param from_value [String] Inclusive from value
         # @param to_value [String] Exclusive to value
         # @return [Google::Cloud::Bigtable::ValueRange]
+        #   Range with an inclusive from value and an exclusive to value.
         #
         # @example
         #   require "google/cloud/bigtable"