google-cloud-spanner 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65d994b98b82ef3397a11c418a6b46f54d76eca91c79dd02c024ad4761dcf0c0
-  data.tar.gz: 805fb5c52d24d20902c609b83d9afd7aafa1ff6bd4bc8a35485bc04db2441322
+  metadata.gz: e8347879380e3278cec1dee95179755b0f1ff4ffecea9fae6b04861bd43976d1
+  data.tar.gz: b6c66cb0637a396bfee1e590b6316826f24a5dc45739c57de19c14c0304bc501
 SHA512:
-  metadata.gz: f624455464b4ec987fde529f018f6b1e88b5a9ad5e769cd7bcb034980af1ebae5cde7c7567e92f9e5bc35226e0ade6be852e63d601b1d83420d75c0c35c3f1ba
-  data.tar.gz: 8baa9252146c458bb5f48aa7043c97584a4295d7afee72e21691e9a4be623d9fc8d9c62cc6f0a8b9c3b8ad0d4b34209a0ee48d88e98b9bd695153ea7024a5a8d
+  metadata.gz: 5a2caf305e7484bd7c17d89973ee3eb536a11b202fa7b85443f33b60ebafc65fb67a57106ca75fda2d448c45614479c44745344af17267f6577b37a5389c2d02
+  data.tar.gz: 3be51dc4c55d948f57c19e2be190cbc27b259793d63b77d366ae9bc8beb7e64c67135127e130b3837305576a41eb5ae370e810ec58ccbb46f627e0816c0359f8

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History
 
+### 2.8.0 / 2021-06-17
+
+#### Features
+
+* create instance using processing units/node count ([#11379](https://www.github.com/googleapis/google-cloud-ruby/issues/11379))
+  * create instance using processing units/node count
+  * fix typo
+  * removed node count and processing unit validations
+  * update orignal value on instance save
+  * remove orignal_values to current_valuess
+
 ### 2.7.0 / 2021-06-09
 
 #### Features

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

@@ -68,6 +68,7 @@ module Google
         def initialize grpc, service
           @grpc = grpc
           @service = service
+          @current_values = grpc.to_h
         end
 
         # The unique identifier for the project.
@@ -134,6 +135,23 @@ module Google
         end
         alias node_count= nodes=
 
+        ##
+        # The number of processing units allocated to this instance.
+        #
+        # @return [Integer]
+        def processing_units
+          @grpc.processing_units
+        end
+
+        ##
+        # Updates number of processing units allocated to this instance.
+        #
+        # @param units [Integer] The number of processing units allocated
+        #   to this instance.
+        def processing_units= units
+          @grpc.processing_units = units
+        end
+
         ##
         # The current instance state. Possible values are `:CREATING` and
         # `:READY`.
@@ -188,8 +206,50 @@ module Google
           )
         end
 
+        ##
+        # Update changes.
+        #  `display_name`, `labels`, `nodes`, `processing_units` can be
+        #  updated. `processing_units` and `nodes` can be used interchangeably
+        #  to update.
+        #
+        # @return [Instance::Job] The job representing the long-running,
+        #   asynchronous processing of an instance update operation.
+        # @raise [ArgumentError] if both processing_units or nodes are specified.
+        #
+        # @example
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   instance = spanner.instance "my-instance"
+        #   instance.display_name = "prod-instance"
+        #   instance.labels = { env: "prod", app: "api" }
+        #   instance.nodes = 2
+        #   # OR
+        #   # instance.processing_units = 500
+        #
+        #   job = instance.save
+        #
+        #   job.done? #=> false
+        #   job.reload! # API call
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     instance = job.instance
+        #   end
+        #
         def save
-          job_grpc = service.update_instance @grpc
+          ensure_service!
+
+          field_mask = []
+          @current_values.each do |field, value|
+            field_mask << field unless @grpc[field.to_s] == value
+          end
+
+          job_grpc = service.update_instance @grpc, field_mask: field_mask
+          @current_values = @grpc.to_h
           Instance::Job.from_grpc job_grpc, service
         end
         alias update save

data/lib/google/cloud/spanner/project.rb

@@ -177,7 +177,10 @@ module Google
         #   configuration. Values can be the `instance_config_id`, the full
         #   path, or an {Instance::Config} object. Required.
         # @param [Integer] nodes The number of nodes allocated to this instance.
-        #   Required.
+        #   Optional. Specify either `nodes` or `processing_units`
+        # @param [Integer] processing_units The number of processing units
+        #   allocated to this instance. Optional. Specify either `nodes`
+        #   or `processing_units`
         # @param [Hash] labels Cloud Labels are a flexible and lightweight
         #   mechanism for organizing cloud resources into groups that reflect a
         #   customer's organizational needs and deployment strategies. Cloud
@@ -195,6 +198,7 @@ module Google
         #
         # @return [Instance::Job] The job representing the long-running,
         #   asynchronous processing of an instance create operation.
+        # @raise [ArgumentError] if both processing_units or nodes are specified.
         #
         # @example
         #   require "google/cloud/spanner"
@@ -217,14 +221,36 @@ module Google
         #     instance = job.instance
         #   end
         #
+        # @example Create instance using processsing units
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   job = spanner.create_instance "my-new-instance",
+        #                                 name: "My New Instance",
+        #                                 config: "regional-us-central1",
+        #                                 processing_units: 500,
+        #                                 labels: { production: :env }
+        #
+        #   job.done? #=> false
+        #   job.reload! # API call
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     instance = job.instance
+        #   end
+        #
         def create_instance instance_id, name: nil, config: nil, nodes: nil,
-                            labels: nil
+                            processing_units: nil, labels: nil
           config = config.path if config.respond_to? :path
+
           # Convert from possible Google::Protobuf::Map
           labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
           grpc = service.create_instance \
             instance_id, name: name, config: config, nodes: nodes,
-                         labels: labels
+                         processing_units: processing_units, labels: labels
           Instance::Job.from_grpc grpc, service
         end
 

data/lib/google/cloud/spanner/service.rb

@@ -127,13 +127,15 @@ module Google
         end
 
         def create_instance instance_id, name: nil, config: nil, nodes: nil,
-                            labels: nil, call_options: nil
+                            processing_units: nil, labels: nil,
+                            call_options: nil
           opts = default_options call_options: call_options
           labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
 
           create_obj = Admin::Instance::V1::Instance.new({
             display_name: name, config: instance_config_path(config),
-            node_count: nodes, labels: labels
+            node_count: nodes, processing_units: processing_units,
+            labels: labels
           }.delete_if { |_, v| v.nil? })
 
           request = {
@@ -144,12 +146,17 @@ module Google
           instances.create_instance request, opts
         end
 
-        def update_instance instance, call_options: nil
+        def update_instance instance, field_mask: nil, call_options: nil
           opts = default_options call_options: call_options
-          mask = Google::Protobuf::FieldMask.new(
-            paths: %w[display_name node_count labels]
-          )
-          request = { instance: instance, field_mask: mask }
+
+          if field_mask.nil? || field_mask.empty?
+            field_mask = %w[display_name node_count labels]
+          end
+
+          request = {
+            instance: instance,
+            field_mask: Google::Protobuf::FieldMask.new(paths: field_mask)
+          }
           instances.update_instance request, opts
         end
 

data/lib/google/cloud/spanner/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "2.7.0".freeze
+      VERSION = "2.8.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core