google-cloud-bigtable 0.6.2 → 0.7.0

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

@@ -20,10 +20,12 @@ require "google/cloud/bigtable/instance/list"
 require "google/cloud/bigtable/instance/cluster_map"
 require "google/cloud/bigtable/app_profile"
 require "google/cloud/bigtable/policy"
+require "google/cloud/bigtable/routing_policy"
 
 module Google
   module Cloud
     module Bigtable
+      ##
       # # Instance
       #
       # Represents a Bigtable instance. Instances are dedicated Bigtable
@@ -40,7 +42,7 @@ module Google
       #
       #   job = bigtable.create_instance(
       #     "my-instance",
-      #     "Instance for user data",
+      #     display_name: "Instance for user data",
       #     type: :DEVELOPMENT,
       #     labels: { "env" => "dev"}
       #   ) do |clusters|
@@ -72,86 +74,96 @@ module Google
           @service = service
         end
 
+        ##
         # The unique identifier for the project.
         #
         # @return [String]
-
+        #
         def project_id
           @grpc.name.split("/")[1]
         end
 
+        ##
         # The unique identifier for the instance.
         #
         # @return [String]
-
+        #
         def instance_id
           @grpc.name.split("/")[3]
         end
 
+        ##
         # The descriptive name for this instance as it appears in UIs. Must be
         # unique per project and between 4 and 30 characters long.
         #
         # @return [String]
-
+        #
         def display_name
           @grpc.display_name
         end
 
+        ##
         # Updates the descriptive name for this instance as it appears in UIs.
         # Can be changed at any time, but should be kept globally unique
         # to avoid confusion.
         #
         # @param value [String] The descriptive name for this instance.
-
+        #
         def display_name= value
           @grpc.display_name = value
         end
 
+        ##
         # The full path for the instance resource. Values are of the form
         # `projects/<project_id>/instances/<instance_id>`.
         #
         # @return [String]
-
+        #
         def path
           @grpc.name
         end
 
+        ##
         # The current instance state. Possible values are `:CREATING`,
         # `:READY`, `:STATE_NOT_KNOWN`.
         #
         # @return [Symbol]
-
+        #
         def state
           @grpc.state
         end
 
+        ##
         # The instance has been successfully created and can serve requests
         # to its tables.
         #
         # @return [Boolean]
-
+        #
         def ready?
           state == :READY
         end
 
+        ##
         # The instance is currently being created and may be destroyed if the
         # creation process encounters an error.
         #
         # @return [Boolean]
-
+        #
         def creating?
           state == :CREATING
         end
 
+        ##
         # Instance type. Possible values are `:DEVELOPMENT`, `:PRODUCTION`,
         # `:TYPE_UNSPECIFIED`
         #
         # @return [Symbol]
-
+        #
         def type
           @grpc.type
         end
 
+        ##
         # The instance is meant for development and testing purposes only; it has
         # no performance or uptime guarantees and is not covered by SLA.
         # After a development instance is created, it can be upgraded by
@@ -161,20 +173,22 @@ module Google
         # not be set.
         #
         # @return [Boolean]
-
+        #
         def development?
           type == :DEVELOPMENT
         end
 
+        ##
         # An instance meant for production use. `serve_nodes` must be set
         # on the cluster.
         #
         # @return [Boolean]
-
+        #
         def production?
           type == :PRODUCTION
         end
 
+        ##
         # Set instance type.
         #
         # Valid values are `:DEVELOPMENT`, `:PRODUCTION`.
@@ -184,11 +198,12 @@ module Google
         # development instance.
         #
         # @param instance_type [Symbol]
-
+        #
         def type= instance_type
           @grpc.type = instance_type
         end
 
+        ##
         # Get instance labels.
         #
         # Cloud Labels are a flexible and lightweight mechanism for organizing
@@ -205,15 +220,16 @@ module Google
         # * No more than 64 labels can be associated with a given resource.
         #
         # @return [Hash{String=>String}] The label keys and values in a hash.
-
+        #
         def labels
           @grpc.labels
         end
 
+        ##
         # Set the Cloud Labels.
         #
         # @param labels [Hash{String=>String}] The Cloud Labels.
-
+        #
         def labels= labels
           labels ||= {}
           @grpc.labels = Google::Protobuf::Map.new(
@@ -222,6 +238,7 @@ module Google
           )
         end
 
+        ##
         # Update instance.
         #
         # Updatable attributes are :
@@ -256,26 +273,26 @@ module Google
         #     puts instance.name
         #     puts instance.labels
         #   end
-
+        #
         def save
           ensure_service!
-          update_mask = Google::Protobuf::FieldMask.new(
-            paths: %w[labels display_name type]
-          )
-          grpc = service.partial_update_instance(@grpc, update_mask)
-          Instance::Job.from_grpc(grpc, service)
+          update_mask = Google::Protobuf::FieldMask.new paths: ["labels", "display_name", "type"]
+          grpc = service.partial_update_instance @grpc, update_mask
+          Instance::Job.from_grpc grpc, service
         end
         alias update save
 
+        ##
         # Reload instance information.
         #
         # @return [Google::Cloud::Bigtable::Instance]
-
+        #
         def reload!
-          @grpc = service.get_instance(instance_id)
+          @grpc = service.get_instance instance_id
           self
         end
 
+        ##
         # Permanently deletes the instance from a project.
         #
         # @return [Boolean] Returns `true` if the instance was deleted.
@@ -287,13 +304,14 @@ module Google
         #
         #   instance = bigtable.instance("my-instance")
         #   instance.delete
-
+        #
         def delete
           ensure_service!
-          service.delete_instance(instance_id)
+          service.delete_instance instance_id
           true
         end
 
+        ##
         # Lists information about clusters in an instance.
         #
         #  See to delete {Google::Cloud::Bigtable::Cluster#delete} and update
@@ -315,13 +333,14 @@ module Google
         #   instance.clusters.all do |cluster|
         #     puts cluster.cluster_id
         #   end
-
+        #
         def clusters token: nil
           ensure_service!
-          grpc = service.list_clusters(instance_id, token: token)
-          Cluster::List.from_grpc(grpc, service, instance_id: instance_id)
+          grpc = service.list_clusters instance_id, token: token
+          Cluster::List.from_grpc grpc, service, instance_id: instance_id
         end
 
+        ##
         # Gets cluster information.
         #
         #  See to delete {Google::Cloud::Bigtable::Cluster#delete} and update
@@ -339,15 +358,16 @@ module Google
         #
         #   cluster = instance.cluster("my-instance-cluster")
         #   puts cluster.cluster_id
-
+        #
         def cluster cluster_id
           ensure_service!
-          grpc = service.get_cluster(instance_id, cluster_id)
-          Cluster.from_grpc(grpc, service)
+          grpc = service.get_cluster instance_id, cluster_id
+          Cluster.from_grpc grpc, service
         rescue Google::Cloud::NotFoundError
           nil
         end
 
+        ##
         # Creates a cluster within an instance.
         #
         # @param cluster_id [String]
@@ -391,20 +411,21 @@ module Google
         #   else
         #     cluster = job.cluster
         #   end
-
+        #
         def create_cluster cluster_id, location, nodes: nil, storage_type: nil
           ensure_service!
           attrs = {
-            serve_nodes: nodes,
+            serve_nodes:          nodes,
             default_storage_type: storage_type,
-            location: location
+            location:             location
           }.delete_if { |_, v| v.nil? }
 
-          cluster = Google::Bigtable::Admin::V2::Cluster.new(attrs)
-          grpc = service.create_cluster(instance_id, cluster_id, cluster)
-          Cluster::Job.from_grpc(grpc, service)
+          cluster = Google::Bigtable::Admin::V2::Cluster.new attrs
+          grpc = service.create_cluster instance_id, cluster_id, cluster
+          Cluster::Job.from_grpc grpc, service
         end
 
+        ##
         # List all tables.
         #
         #  See to delete table {Google::Cloud::Bigtable::Table#delete} and update
@@ -425,18 +446,13 @@ module Google
         #     puts table.name
         #   end
         #
-        #   # Full view
-        #   instance.tables(view: :FULL).all do |table|
-        #     puts table.name
-        #     puts table.column_families
-        #   end
-        #
         def tables
           ensure_service!
-          grpc = service.list_tables(instance_id)
-          Table::List.from_grpc(grpc, service)
+          grpc = service.list_tables instance_id
+          Table::List.from_grpc grpc, service
         end
 
+        ##
         # Get metadata information of table.
         #
         # @param view [Symbol]
@@ -495,13 +511,10 @@ module Google
           ensure_service!
 
           table = if perform_lookup
-                    grpc = service.get_table(instance_id, table_id, view: view)
-                    Table.from_grpc(grpc, service, view: view)
+                    grpc = service.get_table instance_id, table_id, view: view
+                    Table.from_grpc grpc, service, view: view
                   else
-                    Table.from_path(
-                      service.table_path(instance_id, table_id),
-                      service
-                    )
+                    Table.from_path service.table_path(instance_id, table_id), service
                   end
 
           table.app_profile_id = app_profile_id
@@ -510,7 +523,8 @@ module Google
           nil
         end
 
-        # Create table
+        ##
+        # Creates a new table.
         #
         # The table can be created with a full set of initial column families,
         # specified in the request.
@@ -518,9 +532,9 @@ module Google
         # @param name [String]
         #   The name by which the new table should be referred to within the parent
         #   instance, e.g., `foobar`
-        # @param column_families [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
-        #   (See {Google::Cloud::Bigtable::Table::ColumnFamilyMap})
-        #   If passed as an empty, use a code block to add column families.
+        # @param column_families [Google::Cloud::Bigtable::ColumnFamilyMap]
+        #   An object containing the column families for the table, mapped by
+        #   column family name.
         # @param granularity [Symbol]
         #   The granularity at which timestamps are stored in this table.
         #   Timestamps not matching the granularity will be rejected.
@@ -544,15 +558,14 @@ module Google
         #     * Tablet 5 : `[other, )                => {"other", "zz"}`
         #   A hash in the form of `Google::Bigtable::Admin::V2::CreateTableRequest::Split`
         #   can also be provided.
-        # @yield [column_families] A block for adding column_families.
-        # @yieldparam [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
-        #   Cluster map of cluster name and cluster object.
-        #   (See {Google::Cloud::Bigtable::Instance::ClusterMap})
-        #   See rules for column families at {Google::Cloud::Bigtable::GcRule})
+        # @yield [column_families] A block for adding column families.
+        # @yieldparam [Google::Cloud::Bigtable::ColumnFamilyMap] column_families
+        #   A mutable object containing the column families for the table,
+        #   mapped by column family name.
         #
         # @return [Google::Cloud::Bigtable::Table]
         #
-        # @example Create table without column families.
+        # @example Create a table without column families.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -562,63 +575,61 @@ module Google
         #   table = instance.create_table("my-table")
         #   puts table.name
         #
-        # @example Create table with column families and initial splits.
+        # @example Create a table with initial splits and column families.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
         #   instance = bigtable.instance("my-instance")
         #
-        #   table = instance.create_table(my-table") do |column_families|
-        #     column_families.add('cf1', Google::Cloud::Bigtable::GcRule.max_versions(3))
-        #     column_families.add('cf2', Google::Cloud::Bigtable::GcRule.max_age(100))
+        #   initial_splits = ["user-00001", "user-100000", "others"]
+        #   table = instance.create_table("my-table", initial_splits: initial_splits) do |cfm|
+        #     cfm.add('cf1', gc_rule: Google::Cloud::Bigtable::GcRule.max_versions(5))
+        #     cfm.add('cf2', gc_rule: Google::Cloud::Bigtable::GcRule.max_age(600))
         #
-        #     gc_rule = Google::Cloud::Bigtable::GcRule.new
-        #     gc_rule.union = [
-        #       Google::Cloud::Bigtable::GcRule.max_versions(3),
+        #     gc_rule = Google::Cloud::Bigtable::GcRule.union(
         #        Google::Cloud::Bigtable::GcRule.max_age(1800),
-        #     ]
-        #     column_families.add('cf3', gc_rule)
+        #       Google::Cloud::Bigtable::GcRule.max_versions(3)
+        #     )
+        #     cfm.add('cf3', gc_rule: gc_rule)
         #   end
         #
         #   puts table
-
-        def create_table \
-            name,
-            column_families: nil,
-            granularity: nil,
-            initial_splits: nil,
-            &block
+        #
+        def create_table name, column_families: nil, granularity: nil, initial_splits: nil, &block
           ensure_service!
           Table.create(
             service,
             instance_id,
             name,
             column_families: column_families,
-            granularity: granularity,
-            initial_splits: initial_splits,
+            granularity:     granularity,
+            initial_splits:  initial_splits,
             &block
           )
         end
 
+        ##
         # Create app profile for an instance with a routing policy.
         # Only one routing policy can applied to app profile. The policy can be
         # multi-cluster routing or single cluster routing.
         #
         # @param name [String] Unique Id of the app profile
-        # @param routing_policy [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting | Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
-        #   The routing policy for all read/write requests that use this app profile.
-        #   A value must be explicitly set.
+        # @param routing_policy [Google::Cloud::Bigtable::RoutingPolicy]
+        #   The routing policy for all read/write requests that use this app
+        #   profile. A value must be explicitly set.
         #
         #   Routing Policies:
-        #   * `multi_cluster_routing` - Read/write requests may be routed to any
-        #     cluster in the instance and will fail over to another cluster in the event
-        #     of transient errors or delays. Choosing this option sacrifices
-        #     read-your-writes consistency to improve availability.
-        #   * `single_cluster_routing` - Unconditionally routes all read/write requests
-        #     to a specific cluster. This option preserves read-your-writes consistency
-        #     but does not improve availability.
-        #     Value contains `cluster_id` and optional field `allow_transactional_writes`.
+        #   * {Google::Cloud::Bigtable::MultiClusterRoutingUseAny} - Read/write
+        #     requests may be routed to any cluster in the instance and will
+        #     fail over to another cluster in the event of transient errors or
+        #     delays. Choosing this option sacrifices read-your-writes
+        #     consistency to improve availability.
+        #   * {Google::Cloud::Bigtable::SingleClusterRouting} - Unconditionally
+        #     routes all read/write requests to a specific cluster. This option
+        #     preserves read-your-writes consistency but does not improve
+        #     availability. Value contains `cluster_id` and optional field
+        #     `allow_transactional_writes`.
         # @param description [String] Description of the use case for this app profile
         # @param etag [String]
         #   Strongly validated etag for optimistic concurrency control. Preserve the
@@ -641,13 +652,13 @@ module Google
         #   instance = bigtable.instance("my-instance")
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
-        #     "my-instance-cluster-1"
+        #     "my-instance-cluster-1",
         #     allow_transactional_writes: true
         #   )
         #
         #   app_profile = instance.create_app_profile(
         #     "my-app-profile",
-        #     routing_policy: routing_policy,
+        #     routing_policy,
         #     description: "App profile for user data instance"
         #   )
         #   puts app_profile.name
@@ -684,27 +695,21 @@ module Google
         #     ignore_warnings: true
         #   )
         #   puts app_profile.name
-
-        def create_app_profile \
-            name,
-            routing_policy,
-            description: nil,
-            etag: nil,
-            ignore_warnings: false
+        #
+        def create_app_profile name, routing_policy, description: nil, etag: nil, ignore_warnings: false
           ensure_service!
-
-          if routing_policy.is_a?(Google::Bigtable::Admin::V2::AppProfile:: \
-              MultiClusterRoutingUseAny)
-            multi_cluster_routing = routing_policy
+          routing_policy_grpc = routing_policy.to_grpc
+          if routing_policy_grpc.is_a? Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny
+            multi_cluster_routing = routing_policy_grpc
           else
-            single_cluster_routing = routing_policy
+            single_cluster_routing = routing_policy_grpc
           end
 
           app_profile_attrs = {
             multi_cluster_routing_use_any: multi_cluster_routing,
-            single_cluster_routing: single_cluster_routing,
-            description: description,
-            etag: etag
+            single_cluster_routing:        single_cluster_routing,
+            description:                   description,
+            etag:                          etag
           }.delete_if { |_, v| v.nil? }
 
           grpc = service.create_app_profile(
@@ -713,9 +718,10 @@ module Google
             Google::Bigtable::Admin::V2::AppProfile.new(app_profile_attrs),
             ignore_warnings: ignore_warnings
           )
-          AppProfile.from_grpc(grpc, service)
+          AppProfile.from_grpc grpc, service
         end
 
+        ##
         # Get app profile.
         #
         #  See to delete app_profile {Google::Cloud::Bigtable::AppProfile#delete} and update
@@ -736,15 +742,16 @@ module Google
         #   if app_profile
         #     puts app_profile.name
         #   end
-
+        #
         def app_profile app_profile_id
           ensure_service!
-          grpc = service.get_app_profile(instance_id, app_profile_id)
-          AppProfile.from_grpc(grpc, service)
+          grpc = service.get_app_profile instance_id, app_profile_id
+          AppProfile.from_grpc grpc, service
         rescue Google::Cloud::NotFoundError
           nil
         end
 
+        ##
         # List all app profiles
         #
         #  See to delete app_profile {Google::Cloud::Bigtable::AppProfile#delete} and update
@@ -763,13 +770,14 @@ module Google
         #   instance.app_profiles.all do |app_profile|
         #     puts app_profile.name
         #   end
-
+        #
         def app_profiles
           ensure_service!
-          grpc = service.list_app_profiles(instance_id)
-          AppProfile::List.from_grpc(grpc, service)
+          grpc = service.list_app_profiles instance_id
+          AppProfile::List.from_grpc grpc, service
         end
 
+        ##
         # Gets the [Cloud IAM](https://cloud.google.com/iam/) access control
         # policy for this instance.
         #
@@ -793,7 +801,7 @@ module Google
         #   policy = instance.policy
         #
         # @example Update the policy by passing a block:
-        #   require "google/cloud/spanner"
+        #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #   instance = bigtable.instance("my-instance")
@@ -801,16 +809,17 @@ module Google
         #   instance.policy do |p|
         #     p.add("roles/owner", "user:owner@example.com")
         #   end # 2 API calls
-
+        #
         def policy
           ensure_service!
-          grpc = service.get_instance_policy(instance_id)
-          policy = Policy.from_grpc(grpc)
+          grpc = service.get_instance_policy instance_id
+          policy = Policy.from_grpc grpc
           return policy unless block_given?
           yield policy
           update_policy policy
         end
 
+        ##
         # Updates the [Cloud IAM](https://cloud.google.com/iam/) access control
         # policy for this instance. The policy should be read from {#policy}.
         # See {Google::Cloud::Bigtable::Policy} for an explanation of the policy
@@ -836,14 +845,15 @@ module Google
         #   updated_policy = instance.update_policy(policy)
         #
         #   puts update_policy.roles
-
+        #
         def update_policy new_policy
           ensure_service!
-          grpc = service.set_instance_policy(instance_id, new_policy.to_grpc)
-          Policy.from_grpc(grpc)
+          grpc = service.set_instance_policy instance_id, new_policy.to_grpc
+          Policy.from_grpc grpc
         end
         alias policy= update_policy
 
+        ##
         # Tests the specified permissions against the [Cloud
         # IAM](https://cloud.google.com/iam/) access control policy.
         #
@@ -873,13 +883,13 @@ module Google
         #
         #   instance = bigtable.instance("my-instance")
         #
-        #   permissions = bigtable.test_permissions(
+        #   permissions = instance.test_iam_permissions(
         #     "bigtable.instances.get",
         #     "bigtable.instances.update"
         #   )
         #   permissions.include? "bigtable.instances.get" #=> true
         #   permissions.include? "bigtable.instances.update" #=> false
-
+        #
         def test_iam_permissions *permissions
           ensure_service!
           grpc = service.test_instance_permissions(
@@ -897,9 +907,9 @@ module Google
         # @param grpc [Google::Bigtable::Admin::V2::Instance]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Instance]
-
+        #
         def self.from_grpc grpc, service
-          new(grpc, service)
+          new grpc, service
         end
 
         protected
@@ -908,7 +918,7 @@ module Google
         #
         # Raise an error unless an active connection to the service is
         # available.
-
+        #
         def ensure_service!
           raise "Must have active connection to service" unless service
         end