google-cloud-bigtable 1.3.0

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Cloud
+    module Bigtable
+      class AppProfile
+        ##
+        # AppProfile::List is a special-case array with additional
+        # values.
+        class List < DelegateClass(::Array)
+          # @private
+          # The gRPC Service object.
+          attr_accessor :service
+
+          # @private
+          # The gRPC page enumerable object.
+          attr_accessor :grpc
+
+          # @private
+          # Creates a new AppProfile::List with an array of app profiles.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there is a next page of app profiles.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud/bigtable"
+          #
+          #   bigtable = Google::Cloud::Bigtable.new
+          #
+          #   instance = bigtable.instance("my-instance")
+          #   app_profiles = instance.app_profiles
+          #
+          #   if app_profiles.next?
+          #     next_app_profiles = app_profiles.next
+          #   end
+          #
+          def next?
+            grpc.next_page?
+          end
+
+          ##
+          # Retrieves the next page of app profiles.
+          #
+          # @return [AppProfile::List] The list of app profiles.
+          #
+          # @example
+          #   require "google/cloud/bigtable"
+          #
+          #   bigtable = Google::Cloud::Bigtable.new
+          #
+          #   instance = bigtable.instance("my-instance")
+          #   app_profiles = instance.app_profiles
+          #
+          #   if app_profiles.next?
+          #     next_app_profiles = app_profiles.next
+          #   end
+          #
+          def next
+            ensure_grpc!
+
+            return nil unless next?
+            grpc.next_page
+            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.
+          #
+          # An enumerator is returned if no block is given.
+          #
+          # This method will make repeated API calls until all remaining results
+          # 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 app profile.
+          # @yieldparam [AppProfile] app_profile The app profile object.
+          #
+          # @return [Enumerator,nil] An enumerator is returned if no block is given, otherwise `nil`.
+          #
+          # @example Iterating each app profile by passing a block:
+          #   require "google/cloud/bigtable"
+          #
+          #   bigtable = Google::Cloud::Bigtable.new
+          #
+          #   instance = bigtable.instance("my-instance")
+          #   app_profiles = instance.app_profiles
+          #
+          #   instance.app_profiles.all do |app_profile|
+          #     puts app_profile.name
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud/bigtable"
+          #
+          #   bigtable = Google::Cloud::Bigtable.new
+          #
+          #   instance = bigtable.instance("my-instance")
+          #
+          #   all_app_profile_ids = instance.app_profiles.all.map do |app_profile|
+          #     app_profile.name
+          #   end
+          #
+          def all
+            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
+            end
+          end
+
+          # @private
+          # New Snapshot::List from a Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::AppProfile> object.
+          # @param grpc [Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::AppProfile> ]
+          # @param service [Google::Cloud::Bigtable::Service]
+          # @return [Array<Google::Cloud::Bigtable::AppProfile>]
+          def self.from_grpc grpc, service
+            app_profiles = List.new(
+              Array(grpc.response.app_profiles).map do |app_profile|
+                AppProfile.from_grpc app_profile, service
+              end
+            )
+            app_profiles.grpc = grpc
+            app_profiles.service = service
+            app_profiles
+          end
+
+          protected
+
+          # @private
+          #
+          # Raises an error if an active gRPC call is not available.
+          def ensure_grpc!
+            raise "Must have active gRPC call" unless grpc
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,324 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/bigtable/backup/job"
+require "google/cloud/bigtable/backup/list"
+require "google/cloud/bigtable/convert"
+require "google/cloud/bigtable/table/restore_job"
+
+
+module Google
+  module Cloud
+    module Bigtable
+      ##
+      # # Backup
+      #
+      # A backup of a Cloud Bigtable table. See {Cluster#create_backup}, {Cluster#backup} and {Cluster#backups}.
+      #
+      # @example
+      #   require "google/cloud/bigtable"
+      #
+      #   bigtable = Google::Cloud::Bigtable.new
+      #   instance = bigtable.instance("my-instance")
+      #   cluster = instance.cluster("my-cluster")
+      #
+      #   backup = cluster.backup("my-backup")
+      #
+      #   # Update
+      #   backup.expire_time = Time.now + 60 * 60 * 7
+      #   backup.save
+      #
+      #   # Delete
+      #   backup.delete
+      #
+      class Backup
+        # @private
+        # The gRPC Service object.
+        attr_accessor :service
+
+        ##
+        # @private A list of attributes that were updated.
+        attr_reader :updates
+
+        # @private
+        #
+        # Creates a new Backup instance.
+        def initialize grpc, service
+          @grpc = grpc
+          @service = service
+        end
+
+        ##
+        # The unique identifier for the project to which the backup belongs.
+        #
+        # @return [String]
+        #
+        def project_id
+          @grpc.name.split("/")[1]
+        end
+
+        ##
+        # The unique identifier for the instance to which the backup belongs.
+        #
+        # @return [String]
+        #
+        def instance_id
+          @grpc.name.split("/")[3]
+        end
+
+        ##
+        # The unique identifier for the cluster to which the backup belongs.
+        #
+        # @return [String]
+        #
+        def cluster_id
+          @grpc.name.split("/")[5]
+        end
+
+        ##
+        # The unique identifier for the backup.
+        #
+        # @return [String]
+        #
+        def backup_id
+          @grpc.name.split("/")[7]
+        end
+
+        ##
+        # The unique name of the backup. Value in the form
+        # `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
+        #
+        # @return [String]
+        #
+        def path
+          @grpc.name
+        end
+
+        ##
+        # The table from which this backup was created.
+        #
+        # @param perform_lookup [Boolean] Creates table object without verifying that the table resource exists. Calls
+        #   made on this object will raise errors if the table does not exist. Default value is `false`. Optional. Helps
+        #   to reduce admin API calls.
+        # @param view [Symbol] Table view type. Default view type is `:SCHEMA_VIEW`. Valid view types are:
+        #
+        #   * `:NAME_ONLY` - Only populates `name`.
+        #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema.
+        #   * `:REPLICATION_VIEW` - Only populates `name` and fields related to the table's replication state.
+        #   * `:FULL` - Populates all fields.
+        #
+        # @return [Table]
+        #
+        def source_table perform_lookup: nil, view: nil
+          table = Table.from_path @grpc.source_table, service
+          return table.reload! view: view if perform_lookup
+          table
+        end
+
+        ##
+        # The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30
+        # days from the time the request is received. Once the expire time has passed, Cloud Bigtable will delete the
+        # backup and free the resources used by the backup.
+        #
+        # @return [Time]
+        #
+        def expire_time
+          Convert.timestamp_to_time @grpc.expire_time
+        end
+
+        ##
+        # Sets the expiration time of the backup, with microseconds granularity that must be at least 6 hours and at
+        # most 30 days from the time the request is received. Once the {#expire_time} has passed, Cloud Bigtable will
+        # delete the backup and free the resources used by the backup.
+        #
+        # @param [Time] new_expire_time The new expiration time of the backup.
+        #
+        def expire_time= new_expire_time
+          @grpc.expire_time = Convert.time_to_timestamp new_expire_time
+        end
+
+        ##
+        # The time that the backup was started (i.e. approximately the time the `CreateBackup` request is received). The
+        # row data in this backup will be no older than this timestamp.
+        #
+        # @return [Time]
+        #
+        def start_time
+          Convert.timestamp_to_time @grpc.start_time
+        end
+
+        ##
+        # The time that the backup was finished. The row data in the backup will be no newer than this timestamp.
+        #
+        # @return [Time]
+        #
+        def end_time
+          Convert.timestamp_to_time @grpc.end_time
+        end
+
+        ##
+        # The size of the backup in bytes.
+        #
+        # @return [Integer]
+        #
+        def size_bytes
+          @grpc.size_bytes
+        end
+
+        ##
+        # The current state of the backup. Possible values are `:CREATING` and `:READY`.
+        #
+        # @return [Symbol]
+        #
+        def state
+          @grpc.state
+        end
+
+        ##
+        # The backup is currently being created, and may be destroyed if the creation process encounters an error.
+        #
+        # @return [Boolean]
+        #
+        def creating?
+          state == :CREATING
+        end
+
+        ##
+        # The backup has been successfully created and is ready to serve requests.
+        #
+        # @return [Boolean]
+        #
+        def ready?
+          state == :READY
+        end
+
+        ##
+        # Creates a new table by restoring from a completed backup.
+        #
+        # @param table_id [String] The table ID for the new table. This table must not yet exist. Required.
+        #
+        # @return [Google::Cloud::Bigtable::Table::RestoreJob] The job representing the long-running, asynchronous
+        #   processing of a backup restore table operation.
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #   instance = bigtable.instance("my-instance")
+        #   cluster = instance.cluster("my-cluster")
+        #
+        #   backup = cluster.backup("my-backup")
+        #
+        #   job = backup.restore("my-new-table")
+        #
+        #   job.wait_until_done!
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     table = job.table
+        #     optimized = job.optimize_table_operation_name
+        #   end
+        #
+        def restore table_id
+          grpc = service.restore_table table_id, instance_id, cluster_id, backup_id
+          Table::RestoreJob.from_grpc grpc, service
+        end
+
+        ##
+        # Updates the backup.
+        #
+        # `expire_time` is the only updatable field.
+        #
+        # @return [Boolean] Returns `true` if the update succeeded.
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #   instance = bigtable.instance("my-instance")
+        #   cluster = instance.cluster("my-cluster")
+        #
+        #   backup = cluster.backup("my-backup")
+        #
+        #   # Update
+        #   backup.expire_time = Time.now + 60 * 60 * 7
+        #   backup.save
+        #
+        def save
+          ensure_service!
+          @grpc = service.update_backup @grpc, [:expire_time]
+          true
+        end
+        alias update save
+
+        ##
+        # Reloads backup data.
+        #
+        # @return [Google::Cloud::Bigtable::Backup]
+        #
+        def reload!
+          @grpc = service.get_backup instance_id, cluster_id, backup_id
+          self
+        end
+
+        ##
+        # Permanently deletes the backup.
+        #
+        # @return [Boolean] Returns `true` if the backup was deleted.
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #   instance = bigtable.instance("my-instance")
+        #   cluster = instance.cluster("my-cluster")
+        #
+        #   backup = cluster.backup("my-backup")
+        #
+        #   backup.delete
+        #
+        def delete
+          ensure_service!
+          service.delete_backup instance_id, cluster_id, backup_id
+          true
+        end
+
+        # @private
+        #
+        # Creates a new Backup instance from a Google::Bigtable::Admin::V2::Backup.
+        #
+        # @param grpc [Google::Bigtable::Admin::V2::Backup]
+        # @param service [Google::Cloud::Bigtable::Service]
+        # @return [Google::Cloud::Bigtable::Backup]
+        def self.from_grpc grpc, service
+          new grpc, service
+        end
+
+        protected
+
+        # @private
+        #
+        # 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
+      end
+    end
+  end
+end