google-cloud-spanner-admin-instance-v1 0.1.0

data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/paths.rb

@@ -0,0 +1,85 @@
+# 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Spanner
+      module Admin
+        module Instance
+          module V1
+            module InstanceAdmin
+              # Path helper methods for the InstanceAdmin API.
+              module Paths
+                ##
+                # Create a fully-qualified Instance resource string.
+                #
+                # The resource will be in the following format:
+                #
+                # `projects/{project}/instances/{instance}`
+                #
+                # @param project [String]
+                # @param instance [String]
+                #
+                # @return [::String]
+                def instance_path project:, instance:
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/instances/#{instance}"
+                end
+
+                ##
+                # Create a fully-qualified InstanceConfig resource string.
+                #
+                # The resource will be in the following format:
+                #
+                # `projects/{project}/instanceConfigs/{instance_config}`
+                #
+                # @param project [String]
+                # @param instance_config [String]
+                #
+                # @return [::String]
+                def instance_config_path project:, instance_config:
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/instanceConfigs/#{instance_config}"
+                end
+
+                ##
+                # Create a fully-qualified Project resource string.
+                #
+                # The resource will be in the following format:
+                #
+                # `projects/{project}`
+                #
+                # @param project [String]
+                #
+                # @return [::String]
+                def project_path project:
+                  "projects/#{project}"
+                end
+
+                extend self
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/spanner/admin/instance/v1/version.rb

@@ -0,0 +1,32 @@
+# 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Spanner
+      module Admin
+        module Instance
+          module V1
+            VERSION = "0.1.0"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb

@@ -0,0 +1,128 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/spanner/admin/instance/v1/spanner_instance_admin.proto
+
+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/iam/v1/iam_policy_pb'
+require 'google/iam/v1/policy_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/spanner/admin/instance/v1/spanner_instance_admin.proto", :syntax => :proto3) do
+    add_message "google.spanner.admin.instance.v1.ReplicaInfo" do
+      optional :location, :string, 1
+      optional :type, :enum, 2, "google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType"
+      optional :default_leader_location, :bool, 3
+    end
+    add_enum "google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType" do
+      value :TYPE_UNSPECIFIED, 0
+      value :READ_WRITE, 1
+      value :READ_ONLY, 2
+      value :WITNESS, 3
+    end
+    add_message "google.spanner.admin.instance.v1.InstanceConfig" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      repeated :replicas, :message, 3, "google.spanner.admin.instance.v1.ReplicaInfo"
+    end
+    add_message "google.spanner.admin.instance.v1.Instance" do
+      optional :name, :string, 1
+      optional :config, :string, 2
+      optional :display_name, :string, 3
+      optional :node_count, :int32, 5
+      optional :state, :enum, 6, "google.spanner.admin.instance.v1.Instance.State"
+      map :labels, :string, :string, 7
+      repeated :endpoint_uris, :string, 8
+    end
+    add_enum "google.spanner.admin.instance.v1.Instance.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :READY, 2
+    end
+    add_message "google.spanner.admin.instance.v1.ListInstanceConfigsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.spanner.admin.instance.v1.ListInstanceConfigsResponse" do
+      repeated :instance_configs, :message, 1, "google.spanner.admin.instance.v1.InstanceConfig"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.spanner.admin.instance.v1.GetInstanceConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.spanner.admin.instance.v1.GetInstanceRequest" do
+      optional :name, :string, 1
+      optional :field_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.spanner.admin.instance.v1.CreateInstanceRequest" do
+      optional :parent, :string, 1
+      optional :instance_id, :string, 2
+      optional :instance, :message, 3, "google.spanner.admin.instance.v1.Instance"
+    end
+    add_message "google.spanner.admin.instance.v1.ListInstancesRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :filter, :string, 4
+    end
+    add_message "google.spanner.admin.instance.v1.ListInstancesResponse" do
+      repeated :instances, :message, 1, "google.spanner.admin.instance.v1.Instance"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.spanner.admin.instance.v1.UpdateInstanceRequest" do
+      optional :instance, :message, 1, "google.spanner.admin.instance.v1.Instance"
+      optional :field_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.spanner.admin.instance.v1.DeleteInstanceRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.spanner.admin.instance.v1.CreateInstanceMetadata" do
+      optional :instance, :message, 1, "google.spanner.admin.instance.v1.Instance"
+      optional :start_time, :message, 2, "google.protobuf.Timestamp"
+      optional :cancel_time, :message, 3, "google.protobuf.Timestamp"
+      optional :end_time, :message, 4, "google.protobuf.Timestamp"
+    end
+    add_message "google.spanner.admin.instance.v1.UpdateInstanceMetadata" do
+      optional :instance, :message, 1, "google.spanner.admin.instance.v1.Instance"
+      optional :start_time, :message, 2, "google.protobuf.Timestamp"
+      optional :cancel_time, :message, 3, "google.protobuf.Timestamp"
+      optional :end_time, :message, 4, "google.protobuf.Timestamp"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Spanner
+      module Admin
+        module Instance
+          module V1
+            ReplicaInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.ReplicaInfo").msgclass
+            ReplicaInfo::ReplicaType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType").enummodule
+            InstanceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.InstanceConfig").msgclass
+            Instance = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.Instance").msgclass
+            Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.Instance.State").enummodule
+            ListInstanceConfigsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.ListInstanceConfigsRequest").msgclass
+            ListInstanceConfigsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.ListInstanceConfigsResponse").msgclass
+            GetInstanceConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.GetInstanceConfigRequest").msgclass
+            GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.GetInstanceRequest").msgclass
+            CreateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.CreateInstanceRequest").msgclass
+            ListInstancesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.ListInstancesRequest").msgclass
+            ListInstancesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.ListInstancesResponse").msgclass
+            UpdateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.UpdateInstanceRequest").msgclass
+            DeleteInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.DeleteInstanceRequest").msgclass
+            CreateInstanceMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.CreateInstanceMetadata").msgclass
+            UpdateInstanceMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.instance.v1.UpdateInstanceMetadata").msgclass
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb

@@ -0,0 +1,182 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/spanner/admin/instance/v1/spanner_instance_admin.proto for package 'Google.Cloud.Spanner.Admin.Instance.V1'
+# Original file comments:
+# 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
+#
+#     http://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 'grpc'
+require 'google/spanner/admin/instance/v1/spanner_instance_admin_pb'
+
+module Google
+  module Cloud
+    module Spanner
+      module Admin
+        module Instance
+          module V1
+            module InstanceAdmin
+              # Cloud Spanner Instance Admin API
+              #
+              # The Cloud Spanner Instance Admin API can be used to create, delete,
+              # modify and list instances. Instances are dedicated Cloud Spanner serving
+              # and storage resources to be used by Cloud Spanner databases.
+              #
+              # Each instance has a "configuration", which dictates where the
+              # serving resources for the Cloud Spanner instance are located (e.g.,
+              # US-central, Europe). Configurations are created by Google based on
+              # resource availability.
+              #
+              # Cloud Spanner billing is based on the instances that exist and their
+              # sizes. After an instance exists, there are no additional
+              # per-database or per-operation charges for use of the instance
+              # (though there may be additional network bandwidth charges).
+              # Instances offer isolation: problems with databases in one instance
+              # will not affect other instances. However, within an instance
+              # databases can affect each other. For example, if one database in an
+              # instance receives a lot of requests and consumes most of the
+              # instance resources, fewer resources are available for other
+              # databases in that instance, and their performance may suffer.
+              class Service
+
+                include GRPC::GenericService
+
+                self.marshal_class_method = :encode
+                self.unmarshal_class_method = :decode
+                self.service_name = 'google.spanner.admin.instance.v1.InstanceAdmin'
+
+                # Lists the supported instance configurations for a given project.
+                rpc :ListInstanceConfigs, Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest, Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse
+                # Gets information about a particular instance configuration.
+                rpc :GetInstanceConfig, Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceConfigRequest, Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig
+                # Lists all instances in the given project.
+                rpc :ListInstances, Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest, Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse
+                # Gets information about a particular instance.
+                rpc :GetInstance, Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceRequest, Google::Cloud::Spanner::Admin::Instance::V1::Instance
+                # Creates an instance and begins preparing it to begin serving. The
+                # returned [long-running operation][google.longrunning.Operation]
+                # can be used to track the progress of preparing the new
+                # instance. The instance name is assigned by the caller. If the
+                # named instance already exists, `CreateInstance` returns
+                # `ALREADY_EXISTS`.
+                #
+                # Immediately upon completion of this request:
+                #
+                #   * The instance is readable via the API, with all requested attributes
+                #     but no allocated resources. Its state is `CREATING`.
+                #
+                # Until completion of the returned operation:
+                #
+                #   * Cancelling the operation renders the instance immediately unreadable
+                #     via the API.
+                #   * The instance can be deleted.
+                #   * All other attempts to modify the instance are rejected.
+                #
+                # Upon completion of the returned operation:
+                #
+                #   * Billing for all successfully-allocated resources begins (some types
+                #     may have lower than the requested levels).
+                #   * Databases can be created in the instance.
+                #   * The instance's allocated resource levels are readable via the API.
+                #   * The instance's state becomes `READY`.
+                #
+                # The returned [long-running operation][google.longrunning.Operation] will
+                # have a name of the format `<instance_name>/operations/<operation_id>` and
+                # can be used to track creation of the instance.  The
+                # [metadata][google.longrunning.Operation.metadata] field type is
+                # [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
+                # The [response][google.longrunning.Operation.response] field type is
+                # [Instance][google.spanner.admin.instance.v1.Instance], if successful.
+                rpc :CreateInstance, Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceRequest, Google::Longrunning::Operation
+                # Updates an instance, and begins allocating or releasing resources
+                # as requested. The returned [long-running
+                # operation][google.longrunning.Operation] can be used to track the
+                # progress of updating the instance. If the named instance does not
+                # exist, returns `NOT_FOUND`.
+                #
+                # Immediately upon completion of this request:
+                #
+                #   * For resource types for which a decrease in the instance's allocation
+                #     has been requested, billing is based on the newly-requested level.
+                #
+                # Until completion of the returned operation:
+                #
+                #   * Cancelling the operation sets its metadata's
+                #     [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins
+                #     restoring resources to their pre-request values. The operation
+                #     is guaranteed to succeed at undoing all resource changes,
+                #     after which point it terminates with a `CANCELLED` status.
+                #   * All other attempts to modify the instance are rejected.
+                #   * Reading the instance via the API continues to give the pre-request
+                #     resource levels.
+                #
+                # Upon completion of the returned operation:
+                #
+                #   * Billing begins for all successfully-allocated resources (some types
+                #     may have lower than the requested levels).
+                #   * All newly-reserved resources are available for serving the instance's
+                #     tables.
+                #   * The instance's new resource levels are readable via the API.
+                #
+                # The returned [long-running operation][google.longrunning.Operation] will
+                # have a name of the format `<instance_name>/operations/<operation_id>` and
+                # can be used to track the instance modification.  The
+                # [metadata][google.longrunning.Operation.metadata] field type is
+                # [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata].
+                # The [response][google.longrunning.Operation.response] field type is
+                # [Instance][google.spanner.admin.instance.v1.Instance], if successful.
+                #
+                # Authorization requires `spanner.instances.update` permission on
+                # resource [name][google.spanner.admin.instance.v1.Instance.name].
+                rpc :UpdateInstance, Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest, Google::Longrunning::Operation
+                # Deletes an instance.
+                #
+                # Immediately upon completion of the request:
+                #
+                #   * Billing ceases for all of the instance's reserved resources.
+                #
+                # Soon afterward:
+                #
+                #   * The instance and *all of its databases* immediately and
+                #     irrevocably disappear from the API. All data in the databases
+                #     is permanently deleted.
+                rpc :DeleteInstance, Google::Cloud::Spanner::Admin::Instance::V1::DeleteInstanceRequest, Google::Protobuf::Empty
+                # Sets the access control policy on an instance resource. Replaces any
+                # existing policy.
+                #
+                # Authorization requires `spanner.instances.setIamPolicy` on
+                # [resource][google.iam.v1.SetIamPolicyRequest.resource].
+                rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
+                # Gets the access control policy for an instance resource. Returns an empty
+                # policy if an instance exists but does not have a policy set.
+                #
+                # Authorization requires `spanner.instances.getIamPolicy` on
+                # [resource][google.iam.v1.GetIamPolicyRequest.resource].
+                rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
+                # Returns permissions that the caller has on the specified instance resource.
+                #
+                # Attempting this RPC on a non-existent Cloud Spanner instance resource will
+                # result in a NOT_FOUND error if the user has `spanner.instances.list`
+                # permission on the containing Google Cloud Project. Otherwise returns an
+                # empty set of permissions.
+                rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
+              end
+
+              Stub = Service.rpc_stub_class
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud Spanner Instance Admin V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end