google-cloud-bigtable 0.8.0 → 1.0.0

data/lib/google/bigtable/admin/v2/bigtable_table_admin_services_pb.rb

@@ -109,7 +109,7 @@ module Google
             # recommended for production use. It is not subject to any SLA or deprecation
             # policy.
             rpc :DeleteSnapshot, DeleteSnapshotRequest, Google::Protobuf::Empty
-            # Gets the access control policy for an instance resource. Returns an empty
+            # Gets the access control policy for a table resource. Returns an empty
             # policy if an table exists but does not have a policy set.
             rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
             # Sets the access control policy on a table resource. Replaces any existing

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

@@ -5,6 +5,9 @@
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/bigtable/v2/data_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/bigtable/v2/bigtable.proto for package 'google.bigtable.v2'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2019 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -22,7 +22,7 @@ module Google
       # rubocop:disable LineLength
 
       ##
-      # # Ruby Client for Cloud Bigtable Admin API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
+      # # Ruby Client for Cloud Bigtable Admin API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
       #
       # [Cloud Bigtable Admin API][Product Documentation]:
       #

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

@@ -25,7 +25,7 @@ module Google
         # rubocop:disable LineLength
 
         ##
-        # # Ruby Client for Cloud Bigtable Admin API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
+        # # Ruby Client for Cloud Bigtable Admin API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
         #
         # [Cloud Bigtable Admin API][Product Documentation]:
         #

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

@@ -870,7 +870,7 @@ module Google
               @check_consistency.call(req, options, &block)
             end
 
-            # Gets the access control policy for an instance resource. Returns an empty
+            # Gets the access control policy for a table resource. Returns an empty
             # policy if an table exists but does not have a policy set.
             #
             # @param resource [String]

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/policy.rb

@@ -82,12 +82,13 @@ module Google
       #
       #     Operations affecting conditional bindings must specify version 3. This can
       #     be either setting a conditional policy, modifying a conditional binding,
-      #     or removing a conditional binding from the stored conditional policy.
+      #     or removing a binding (conditional or unconditional) from the stored
+      #     conditional policy.
       #     Operations on non-conditional policies may specify any valid value or
       #     leave the field unset.
       #
-      #     If no etag is provided in the call to `setIamPolicy`, any version
-      #     compliance checks on the incoming and/or stored policy is skipped.
+      #     If no etag is provided in the call to `setIamPolicy`, version compliance
+      #     checks against the stored policy is skipped.
       # @!attribute [rw] bindings
       #   @return [Array<Google::Iam::V1::Binding>]
       #     Associates a list of `members` to a `role`. Optionally may specify a
@@ -105,8 +106,8 @@ module Google
       #
       #     If no `etag` is provided in the call to `setIamPolicy`, then the existing
       #     policy is overwritten. Due to blind-set semantics of an etag-less policy,
-      #     'setIamPolicy' will not fail even if either of incoming or stored policy
-      #     does not meet the version requirements.
+      #     'setIamPolicy' will not fail even if the incoming policy version does not
+      #     meet the requirements for modifying the stored policy.
       class Policy; end
 
       # Associates `members` with a `role`.

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

@@ -61,7 +61,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the project.
+        # The unique identifier for the project to which the app profile belongs.
         #
         # @return [String]
         #
@@ -70,7 +70,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the instance.
+        # The unique identifier for the instance to which the app profile belongs.
         #
         # @return [String]
         #
@@ -88,8 +88,8 @@ module Google
         end
 
         ##
-        # The full path for the instance resource. Values are of the form
-        # `projects/<project_id>/instances/<instance_id>`.
+        # The full path for the app profile resource. Values are of the form:
+        # `projects/<project_id>/instances/<instance_id>/appProfiles/<app_profile_name>`.
         #
         # @return [String]
         #
@@ -107,7 +107,7 @@ module Google
         end
 
         ##
-        # Description of the AppProfile.
+        # Description of the app profile.
         #
         # @return [String]
         #
@@ -116,7 +116,7 @@ module Google
         end
 
         ##
-        # Set description of the AppProfile.
+        # Sets the description of the app profile.
         #
         # @param text [String] Description text
         #
@@ -168,7 +168,7 @@ module Google
         #     availability. Value contains `cluster_id` and optional field
         #     `allow_transactional_writes`.
         #
-        # @example Set multi cluster routing policy
+        # @example Set multi cluster routing policy.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -178,7 +178,7 @@ module Google
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #   app_profile.routing_policy = routing_policy
         #
-        # @example Set single cluster routing policy
+        # @example Set single cluster routing policy.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -241,7 +241,7 @@ module Google
         end
 
         ##
-        # Delete app profile.
+        # Deletes the app profile.
         #
         # @param ignore_warnings [Boolean]
         #   Default value is false. If true, ignore safety checks when deleting
@@ -269,14 +269,14 @@ module Google
         end
 
         ##
-        # Update app profile.
+        # Updates the app profile.
         #
         # @param ignore_warnings [Boolean]
         #   Default value is false. If true, ignore safety checks when updating
         #   the app profile.
         # @return [Google::Cloud::Bigtable::AppProfile::Job]
         #
-        # @example Update
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -298,7 +298,7 @@ module Google
         #     app_profile = job.app_profile
         #   end
         #
-        # @example Update with single cluster routing
+        # @example Update with single cluster routing.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -336,7 +336,7 @@ module Google
         alias update save
 
         ##
-        # Reload app profile information.
+        # Reloads the app profile data.
         #
         # @return [Google::Cloud::Bigtable::AppProfile]
         #

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

@@ -32,13 +32,13 @@ module Google
           attr_accessor :grpc
 
           # @private
-          # Creates a new AppProfile::List with an array of snapshot instances.
+          # Creates a new AppProfile::List with an array of app profiles.
           def initialize arr = []
             super arr
           end
 
           ##
-          # Whether there is a next page of instances.
+          # Whether there is a next page of app profiles.
           #
           # @return [Boolean]
           #
@@ -59,9 +59,9 @@ module Google
           end
 
           ##
-          # Retrieves the next page of app_profiles.
+          # Retrieves the next page of app profiles.
           #
-          # @return [AppProfile::List] The list of instances.
+          # @return [AppProfile::List] The list of app profiles.
           #
           # @example
           #   require "google/cloud/bigtable"
@@ -94,12 +94,12 @@ module Google
           # are retrieved (unlike `#each`, for example, which merely iterates
           # over the results returned by a single API call). Use with caution.
           #
-          # @yield [app_profile] The block for accessing each instance.
-          # @yieldparam [AppProfile] instance The instance object.
+          # @yield [app_profile] The block for accessing each app profile.
+          # @yieldparam [AppProfile] app_profile The app profile object.
           #
           # @return [Enumerator]
           #
-          # @example Iterating each instance by passing a block:
+          # @example Iterating each app profile by passing a block:
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new

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

@@ -56,7 +56,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the project.
+        # The unique identifier for the project to which the cluster belongs.
         #
         # @return [String]
         #
@@ -65,7 +65,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the instance.
+        # The unique identifier for the instance to which the cluster belongs.
         #
         # @return [String]
         #
@@ -93,7 +93,7 @@ module Google
         end
 
         ##
-        # The current instance state.
+        # The current state of the cluster.
         # Possible values are
         # `:CREATING`, `:READY`, `:STATE_NOT_KNOWN`, `:RESIZING`, `:DISABLED`.
         #
@@ -113,7 +113,7 @@ module Google
         end
 
         ##
-        # The instance is currently being created, and may be destroyed if the
+        # The cluster is currently being created, and may be destroyed if the
         # creation process encounters an error.
         #
         # @return [Boolean]
@@ -197,9 +197,9 @@ module Google
         end
 
         ##
-        # Update cluster.
+        # Updates the cluster.
         #
-        # `serve_nodes` is the only updatable field
+        # `serve_nodes` is the only updatable field.
         #
         # @return [Google::Cloud::Bigtable::Cluster::Job]
         #   The job representing the long-running, asynchronous processing of
@@ -235,7 +235,7 @@ module Google
         alias update save
 
         ##
-        # Reloads cluster information.
+        # Reloads cluster data.
         #
         # @return [Google::Cloud::Bigtable::Cluster]
         #

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

@@ -53,7 +53,7 @@ module Google
           end
 
           ##
-          # Whether there is a next page of instances.
+          # Whether there is a next page of clusters.
           #
           # @return [Boolean]
           #
@@ -126,7 +126,7 @@ module Google
           #   bigtable = Google::Cloud::Bigtable.new
           #
           #   all_cluster_ids = bigtable.clusters.all.map do |cluster|
-          #     puts cluster.instance_id
+          #     puts cluster.cluster_id
           #   end
           #
           def all

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

@@ -37,10 +37,12 @@ module Google
       #   puts column_family.gc_rule
       #
       class ColumnFamily
-        # Name of the column family
+        ##
+        # Name of the column family.
         # @return [String]
         attr_reader :name
 
+        ##
         # The garbage collection rule to be used for the column family.
         # Optional. The service default value will be used when not specified.
         # @return [Google::Cloud::Bigtable::GcRule, nil]

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

@@ -79,7 +79,7 @@ module Google
         include Enumerable
 
         ##
-        # Create a new ColumnFamilyMap object.
+        # Creates a new ColumnFamilyMap object.
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -108,14 +108,14 @@ module Google
         end
 
         ##
-        # Calls block once for each column family in the map, passing passing
+        # Calls the block once for each column family in the map, passing
         # the name and column family pair as parameters.
         #
         # If no block is given, an enumerator is returned instead.
         #
-        # @yield [name, column_family] The name and column family pair
-        # @yieldparam [String] name the column family name
-        # @yieldparam [ColumnFamily] column_family the column family object
+        # @yield [name, column_family] The name and column family pair.
+        # @yieldparam [String] name the column family name.
+        # @yieldparam [ColumnFamily] column_family the column family object.
         #
         # @return [Enumerator]
         #
@@ -183,7 +183,7 @@ module Google
         # Adds a new column family to the table.
         #
         # @overload add(name, gc_rule: nil)
-        #   @param name [String] Column family name
+        #   @param name [String] Column family name.
         #   @param gc_rule [Google::Cloud::Bigtable::GcRule] The garbage
         #     collection rule to be used for the column family. Optional. The
         #     service default value will be used when not specified.
@@ -222,7 +222,7 @@ module Google
         ##
         # Updates an existing column family in the table.
         #
-        # @param name [String] Column family name
+        # @param name [String] Column family name.
         # @param gc_rule [Google::Cloud::Bigtable::GcRule] The new garbage
         #   collection rule to be used for the column family. Optional. The
         #   service default value will be used when not specified.
@@ -258,7 +258,7 @@ module Google
         ##
         # Deletes the named column family from the table.
         #
-        # @param name [String] Column family name
+        # @param name [String] Column family name.
         #
         # @raise [ArgumentError] if the column family name does not exist.
         # @raise [FrozenError] if the column family map is frozen.

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

@@ -60,7 +60,7 @@ module Google
         end
 
         ##
-        # Get column family name
+        # Gets the column family name.
         #
         # @return [String]
         #
@@ -69,7 +69,7 @@ module Google
         end
 
         ##
-        # Set column family name
+        # Sets the column family name.
         #
         # @param name [String] Column family name
         #
@@ -78,7 +78,7 @@ module Google
         end
 
         ##
-        # Set column range with the lower bound.
+        # Sets the column range with the lower bound.
         #
         # @param qualifier [String] Column qualifier name. Required
         # @param inclusive [String] Lower bound flag. Inclusive/Exclusive.
@@ -111,7 +111,7 @@ module Google
         end
 
         ##
-        # Set column range with the upper bound.
+        # Sets the column range with the upper bound.
         #
         # @param qualifier [String] Column qualifier name. Required.
         # @param inclusive [String] Upper bound flag. Inclusive/Exclusive.
@@ -144,7 +144,7 @@ module Google
         end
 
         ##
-        # Set column range with the inclusive upper and lower bound.
+        # Sets the column range with the inclusive upper and lower bound.
         #
         # @param from_qualifier [String] Inclusive from qualifier. Required.
         # @param to_qualifier [String] Inclusive to qualifier. Required.
@@ -163,7 +163,7 @@ module Google
         end
 
         ##
-        # Set column range with the inclusive upper and the exclusive lower bound.
+        # Sets the column range with the inclusive upper and the exclusive lower bound.
         #
         # @param from_qualifier [String] Inclusive from qualifier
         # @param to_qualifier [String] Exclusive to qualifier

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

@@ -219,12 +219,12 @@ module Google
         end
 
         ##
-        # Create GcRule instance with max number of versions.
+        # Creates a GcRule instance with max number of versions.
         #
         # @param versions [Integer] Max number of versions
         # @return [Google::Cloud::Bigtable::GcRule]
         #
-        # @example Create a table with column families.
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -240,12 +240,12 @@ module Google
         end
 
         ##
-        # Create GcRule instance with max age.
+        # Creates a GcRule instance with max age.
         #
         # @param age [Integer] Max age in seconds.
         # @return [Google::Cloud::Bigtable::GcRule]
         #
-        # @example Create a table with column families.
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -261,13 +261,13 @@ module Google
         end
 
         ##
-        # Create union GcRule instance.
+        # Creates a union GcRule instance.
         #
         # @param rules [Google::Cloud::Bigtable::GcRule, Array<Google::Cloud::Bigtable::GcRule>]
         #   List of GcRule with nested rules.
         # @return [Google::Cloud::Bigtable::GcRule]
         #
-        # @example Create a table with column families.
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -287,13 +287,13 @@ module Google
         end
 
         ##
-        # Create intersection GCRule instance.
+        # Creates a intersection GCRule instance.
         #
         # @param rules [Google::Cloud::Bigtable::GcRule, Array<Google::Cloud::Bigtable::GcRule>]
         #   List of GcRule with nested rules.
         # @return [Google::Cloud::Bigtable::GcRule]
         #
-        # @example Create a table with column families.
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new