google-cloud-filestore-v1 0.1.0

data/lib/google/cloud/filestore/v1/cloud_filestore_manager/paths.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Filestore
+      module V1
+        module CloudFilestoreManager
+          # Path helper methods for the CloudFilestoreManager API.
+          module Paths
+            ##
+            # Create a fully-qualified Backup resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/backups/{backup}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param backup [String]
+            #
+            # @return [::String]
+            def backup_path project:, location:, backup:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/backups/#{backup}"
+            end
+
+            ##
+            # Create a fully-qualified Instance resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/instances/{instance}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param instance [String]
+            #
+            # @return [::String]
+            def instance_path project:, location:, instance:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/instances/#{instance}"
+            end
+
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/filestore/v1/cloud_filestore_service_pb.rb

@@ -0,0 +1,197 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/filestore/v1/cloud_filestore_service.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/longrunning/operations_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/wrappers_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/filestore/v1/cloud_filestore_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.filestore.v1.NetworkConfig" do
+      optional :network, :string, 1
+      repeated :modes, :enum, 3, "google.cloud.filestore.v1.NetworkConfig.AddressMode"
+      optional :reserved_ip_range, :string, 4
+      repeated :ip_addresses, :string, 5
+    end
+    add_enum "google.cloud.filestore.v1.NetworkConfig.AddressMode" do
+      value :ADDRESS_MODE_UNSPECIFIED, 0
+      value :MODE_IPV4, 1
+    end
+    add_message "google.cloud.filestore.v1.FileShareConfig" do
+      optional :name, :string, 1
+      optional :capacity_gb, :int64, 2
+      repeated :nfs_export_options, :message, 7, "google.cloud.filestore.v1.NfsExportOptions"
+      oneof :source do
+        optional :source_backup, :string, 8
+      end
+    end
+    add_message "google.cloud.filestore.v1.NfsExportOptions" do
+      repeated :ip_ranges, :string, 1
+      optional :access_mode, :enum, 2, "google.cloud.filestore.v1.NfsExportOptions.AccessMode"
+      optional :squash_mode, :enum, 3, "google.cloud.filestore.v1.NfsExportOptions.SquashMode"
+      optional :anon_uid, :int64, 4
+      optional :anon_gid, :int64, 5
+    end
+    add_enum "google.cloud.filestore.v1.NfsExportOptions.AccessMode" do
+      value :ACCESS_MODE_UNSPECIFIED, 0
+      value :READ_ONLY, 1
+      value :READ_WRITE, 2
+    end
+    add_enum "google.cloud.filestore.v1.NfsExportOptions.SquashMode" do
+      value :SQUASH_MODE_UNSPECIFIED, 0
+      value :NO_ROOT_SQUASH, 1
+      value :ROOT_SQUASH, 2
+    end
+    add_message "google.cloud.filestore.v1.Instance" do
+      optional :name, :string, 1
+      optional :description, :string, 2
+      optional :state, :enum, 5, "google.cloud.filestore.v1.Instance.State"
+      optional :status_message, :string, 6
+      optional :create_time, :message, 7, "google.protobuf.Timestamp"
+      optional :tier, :enum, 8, "google.cloud.filestore.v1.Instance.Tier"
+      map :labels, :string, :string, 9
+      repeated :file_shares, :message, 10, "google.cloud.filestore.v1.FileShareConfig"
+      repeated :networks, :message, 11, "google.cloud.filestore.v1.NetworkConfig"
+      optional :etag, :string, 12
+      optional :satisfies_pzs, :message, 13, "google.protobuf.BoolValue"
+    end
+    add_enum "google.cloud.filestore.v1.Instance.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :READY, 2
+      value :REPAIRING, 3
+      value :DELETING, 4
+      value :ERROR, 6
+      value :RESTORING, 7
+    end
+    add_enum "google.cloud.filestore.v1.Instance.Tier" do
+      value :TIER_UNSPECIFIED, 0
+      value :STANDARD, 1
+      value :PREMIUM, 2
+      value :BASIC_HDD, 3
+      value :BASIC_SSD, 4
+      value :HIGH_SCALE_SSD, 5
+    end
+    add_message "google.cloud.filestore.v1.CreateInstanceRequest" do
+      optional :parent, :string, 1
+      optional :instance_id, :string, 2
+      optional :instance, :message, 3, "google.cloud.filestore.v1.Instance"
+    end
+    add_message "google.cloud.filestore.v1.GetInstanceRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.filestore.v1.UpdateInstanceRequest" do
+      optional :update_mask, :message, 1, "google.protobuf.FieldMask"
+      optional :instance, :message, 2, "google.cloud.filestore.v1.Instance"
+    end
+    add_message "google.cloud.filestore.v1.RestoreInstanceRequest" do
+      optional :name, :string, 1
+      optional :file_share, :string, 2
+      oneof :source do
+        optional :source_backup, :string, 3
+      end
+    end
+    add_message "google.cloud.filestore.v1.DeleteInstanceRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.filestore.v1.ListInstancesRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :order_by, :string, 4
+      optional :filter, :string, 5
+    end
+    add_message "google.cloud.filestore.v1.ListInstancesResponse" do
+      repeated :instances, :message, 1, "google.cloud.filestore.v1.Instance"
+      optional :next_page_token, :string, 2
+      repeated :unreachable, :string, 3
+    end
+    add_message "google.cloud.filestore.v1.Backup" do
+      optional :name, :string, 1
+      optional :description, :string, 2
+      optional :state, :enum, 3, "google.cloud.filestore.v1.Backup.State"
+      optional :create_time, :message, 4, "google.protobuf.Timestamp"
+      map :labels, :string, :string, 5
+      optional :capacity_gb, :int64, 6
+      optional :storage_bytes, :int64, 7
+      optional :source_instance, :string, 8
+      optional :source_file_share, :string, 9
+      optional :source_instance_tier, :enum, 10, "google.cloud.filestore.v1.Instance.Tier"
+      optional :download_bytes, :int64, 11
+      optional :satisfies_pzs, :message, 12, "google.protobuf.BoolValue"
+    end
+    add_enum "google.cloud.filestore.v1.Backup.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :FINALIZING, 2
+      value :READY, 3
+      value :DELETING, 4
+    end
+    add_message "google.cloud.filestore.v1.CreateBackupRequest" do
+      optional :parent, :string, 1
+      optional :backup, :message, 2, "google.cloud.filestore.v1.Backup"
+      optional :backup_id, :string, 3
+    end
+    add_message "google.cloud.filestore.v1.DeleteBackupRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.filestore.v1.UpdateBackupRequest" do
+      optional :backup, :message, 1, "google.cloud.filestore.v1.Backup"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.filestore.v1.GetBackupRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.filestore.v1.ListBackupsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :order_by, :string, 4
+      optional :filter, :string, 5
+    end
+    add_message "google.cloud.filestore.v1.ListBackupsResponse" do
+      repeated :backups, :message, 1, "google.cloud.filestore.v1.Backup"
+      optional :next_page_token, :string, 2
+      repeated :unreachable, :string, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Filestore
+      module V1
+        NetworkConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.NetworkConfig").msgclass
+        NetworkConfig::AddressMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.NetworkConfig.AddressMode").enummodule
+        FileShareConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.FileShareConfig").msgclass
+        NfsExportOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.NfsExportOptions").msgclass
+        NfsExportOptions::AccessMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.NfsExportOptions.AccessMode").enummodule
+        NfsExportOptions::SquashMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.NfsExportOptions.SquashMode").enummodule
+        Instance = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.Instance").msgclass
+        Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.Instance.State").enummodule
+        Instance::Tier = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.Instance.Tier").enummodule
+        CreateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.CreateInstanceRequest").msgclass
+        GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.GetInstanceRequest").msgclass
+        UpdateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.UpdateInstanceRequest").msgclass
+        RestoreInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.RestoreInstanceRequest").msgclass
+        DeleteInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.DeleteInstanceRequest").msgclass
+        ListInstancesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.ListInstancesRequest").msgclass
+        ListInstancesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.ListInstancesResponse").msgclass
+        Backup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.Backup").msgclass
+        Backup::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.Backup.State").enummodule
+        CreateBackupRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.CreateBackupRequest").msgclass
+        DeleteBackupRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.DeleteBackupRequest").msgclass
+        UpdateBackupRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.UpdateBackupRequest").msgclass
+        GetBackupRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.GetBackupRequest").msgclass
+        ListBackupsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.ListBackupsRequest").msgclass
+        ListBackupsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.filestore.v1.ListBackupsResponse").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/filestore/v1/cloud_filestore_service_services_pb.rb

@@ -0,0 +1,92 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/filestore/v1/cloud_filestore_service.proto for package 'google.cloud.filestore.v1'
+# Original file comments:
+# Copyright 2021 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/cloud/filestore/v1/cloud_filestore_service_pb'
+
+module Google
+  module Cloud
+    module Filestore
+      module V1
+        module CloudFilestoreManager
+          # Configures and manages Cloud Filestore resources.
+          #
+          # Cloud Filestore Manager v1.
+          #
+          # The `file.googleapis.com` service implements the Cloud Filestore API and
+          # defines the following resource model for managing instances:
+          # * The service works with a collection of cloud projects, named: `/projects/*`
+          # * Each project has a collection of available locations, named: `/locations/*`
+          # * Each location has a collection of instances and backups, named:
+          # `/instances/*` and `/backups/*` respectively.
+          # * As such, Cloud Filestore instances are resources of the form:
+          #   `/projects/{project_number}/locations/{location_id}/instances/{instance_id}`
+          #   and backups are resources of the form:
+          #   `/projects/{project_number}/locations/{location_id}/backup/{backup_id}`
+          #
+          # Note that location_id must be a GCP `zone` for instances and but to a GCP
+          # `region` for backups; for example:
+          # * `projects/12345/locations/us-central1-c/instances/my-filestore`
+          # * `projects/12345/locations/us-central1/backups/my-backup`
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.filestore.v1.CloudFilestoreManager'
+
+            # Lists all instances in a project for either a specified location
+            # or for all locations.
+            rpc :ListInstances, ::Google::Cloud::Filestore::V1::ListInstancesRequest, ::Google::Cloud::Filestore::V1::ListInstancesResponse
+            # Gets the details of a specific instance.
+            rpc :GetInstance, ::Google::Cloud::Filestore::V1::GetInstanceRequest, ::Google::Cloud::Filestore::V1::Instance
+            # Creates an instance.
+            # When creating from a backup, the capacity of the new instance needs to be
+            # equal to or larger than the capacity of the backup (and also equal to or
+            # larger than the minimum capacity of the tier).
+            rpc :CreateInstance, ::Google::Cloud::Filestore::V1::CreateInstanceRequest, ::Google::Longrunning::Operation
+            # Updates the settings of a specific instance.
+            rpc :UpdateInstance, ::Google::Cloud::Filestore::V1::UpdateInstanceRequest, ::Google::Longrunning::Operation
+            # Restores an existing instance's file share from a backup.
+            #
+            # The capacity of the instance needs to be equal to or larger than the
+            # capacity of the backup (and also equal to or larger than the minimum
+            # capacity of the tier).
+            rpc :RestoreInstance, ::Google::Cloud::Filestore::V1::RestoreInstanceRequest, ::Google::Longrunning::Operation
+            # Deletes an instance.
+            rpc :DeleteInstance, ::Google::Cloud::Filestore::V1::DeleteInstanceRequest, ::Google::Longrunning::Operation
+            # Lists all backups in a project for either a specified location or for all
+            # locations.
+            rpc :ListBackups, ::Google::Cloud::Filestore::V1::ListBackupsRequest, ::Google::Cloud::Filestore::V1::ListBackupsResponse
+            # Gets the details of a specific backup.
+            rpc :GetBackup, ::Google::Cloud::Filestore::V1::GetBackupRequest, ::Google::Cloud::Filestore::V1::Backup
+            # Creates a backup.
+            rpc :CreateBackup, ::Google::Cloud::Filestore::V1::CreateBackupRequest, ::Google::Longrunning::Operation
+            # Deletes a backup.
+            rpc :DeleteBackup, ::Google::Cloud::Filestore::V1::DeleteBackupRequest, ::Google::Longrunning::Operation
+            # Updates the settings of a specific backup.
+            rpc :UpdateBackup, ::Google::Cloud::Filestore::V1::UpdateBackupRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/filestore/v1/version.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Filestore
+      module V1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Filestore 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,71 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
+    end
+  end
+end