google-cloud-firestore-admin-v1 0.1.0

data/lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb

@@ -0,0 +1,113 @@
+# 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 Firestore
+      module Admin
+        module V1
+          module FirestoreAdmin
+            # Path helper methods for the FirestoreAdmin API.
+            module Paths
+              ##
+              # Create a fully-qualified CollectionGroup resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/databases/{database}/collectionGroups/{collection}`
+              #
+              # @param project [String]
+              # @param database [String]
+              # @param collection [String]
+              #
+              # @return [::String]
+              def collection_group_path project:, database:, collection:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
+
+                "projects/#{project}/databases/#{database}/collectionGroups/#{collection}"
+              end
+
+              ##
+              # Create a fully-qualified Database resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/databases/{database}`
+              #
+              # @param project [String]
+              # @param database [String]
+              #
+              # @return [::String]
+              def database_path project:, database:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                "projects/#{project}/databases/#{database}"
+              end
+
+              ##
+              # Create a fully-qualified Field resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}`
+              #
+              # @param project [String]
+              # @param database [String]
+              # @param collection [String]
+              # @param field [String]
+              #
+              # @return [::String]
+              def field_path project:, database:, collection:, field:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
+                raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+
+                "projects/#{project}/databases/#{database}/collectionGroups/#{collection}/fields/#{field}"
+              end
+
+              ##
+              # Create a fully-qualified Index resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}`
+              #
+              # @param project [String]
+              # @param database [String]
+              # @param collection [String]
+              # @param index [String]
+              #
+              # @return [::String]
+              def index_path project:, database:, collection:, index:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
+                raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+
+                "projects/#{project}/databases/#{database}/collectionGroups/#{collection}/indexes/#{index}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/firestore/admin/v1/version.rb

@@ -0,0 +1,30 @@
+# 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 Firestore
+      module Admin
+        module V1
+          VERSION = "0.1.0"
+        end
+      end
+    end
+  end
+end

data/lib/google/firestore/admin/v1/field_pb.rb

@@ -0,0 +1,35 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/firestore/admin/v1/field.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/firestore/admin/v1/index_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/firestore/admin/v1/field.proto", :syntax => :proto3) do
+    add_message "google.firestore.admin.v1.Field" do
+      optional :name, :string, 1
+      optional :index_config, :message, 2, "google.firestore.admin.v1.Field.IndexConfig"
+    end
+    add_message "google.firestore.admin.v1.Field.IndexConfig" do
+      repeated :indexes, :message, 1, "google.firestore.admin.v1.Index"
+      optional :uses_ancestor_config, :bool, 2
+      optional :ancestor_field, :string, 3
+      optional :reverting, :bool, 4
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          Field = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Field").msgclass
+          Field::IndexConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Field.IndexConfig").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/firestore/admin/v1/firestore_admin_pb.rb

@@ -0,0 +1,87 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/firestore/admin/v1/firestore_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/firestore/admin/v1/field_pb'
+require 'google/firestore/admin/v1/index_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/firestore/admin/v1/firestore_admin.proto", :syntax => :proto3) do
+    add_message "google.firestore.admin.v1.CreateIndexRequest" do
+      optional :parent, :string, 1
+      optional :index, :message, 2, "google.firestore.admin.v1.Index"
+    end
+    add_message "google.firestore.admin.v1.ListIndexesRequest" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :page_size, :int32, 3
+      optional :page_token, :string, 4
+    end
+    add_message "google.firestore.admin.v1.ListIndexesResponse" do
+      repeated :indexes, :message, 1, "google.firestore.admin.v1.Index"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.firestore.admin.v1.GetIndexRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.firestore.admin.v1.DeleteIndexRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.firestore.admin.v1.UpdateFieldRequest" do
+      optional :field, :message, 1, "google.firestore.admin.v1.Field"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.firestore.admin.v1.GetFieldRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.firestore.admin.v1.ListFieldsRequest" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :page_size, :int32, 3
+      optional :page_token, :string, 4
+    end
+    add_message "google.firestore.admin.v1.ListFieldsResponse" do
+      repeated :fields, :message, 1, "google.firestore.admin.v1.Field"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.firestore.admin.v1.ExportDocumentsRequest" do
+      optional :name, :string, 1
+      repeated :collection_ids, :string, 2
+      optional :output_uri_prefix, :string, 3
+    end
+    add_message "google.firestore.admin.v1.ImportDocumentsRequest" do
+      optional :name, :string, 1
+      repeated :collection_ids, :string, 2
+      optional :input_uri_prefix, :string, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          CreateIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.CreateIndexRequest").msgclass
+          ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesRequest").msgclass
+          ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesResponse").msgclass
+          GetIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.GetIndexRequest").msgclass
+          DeleteIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.DeleteIndexRequest").msgclass
+          UpdateFieldRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateFieldRequest").msgclass
+          GetFieldRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.GetFieldRequest").msgclass
+          ListFieldsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListFieldsRequest").msgclass
+          ListFieldsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListFieldsResponse").msgclass
+          ExportDocumentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ExportDocumentsRequest").msgclass
+          ImportDocumentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ImportDocumentsRequest").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb

@@ -0,0 +1,95 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/firestore/admin/v1/firestore_admin.proto for package 'Google.Cloud.Firestore.Admin.V1'
+# Original file comments:
+# Copyright 2019 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/firestore/admin/v1/firestore_admin_pb'
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          module FirestoreAdmin
+            # Operations are created by service `FirestoreAdmin`, but are accessed via
+            # service `google.longrunning.Operations`.
+            class Service
+
+              include GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.firestore.admin.v1.FirestoreAdmin'
+
+              # Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation]
+              # which may be used to track the status of the creation. The metadata for
+              # the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
+              rpc :CreateIndex, Google::Cloud::Firestore::Admin::V1::CreateIndexRequest, Google::Longrunning::Operation
+              # Lists composite indexes.
+              rpc :ListIndexes, Google::Cloud::Firestore::Admin::V1::ListIndexesRequest, Google::Cloud::Firestore::Admin::V1::ListIndexesResponse
+              # Gets a composite index.
+              rpc :GetIndex, Google::Cloud::Firestore::Admin::V1::GetIndexRequest, Google::Cloud::Firestore::Admin::V1::Index
+              # Deletes a composite index.
+              rpc :DeleteIndex, Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest, Google::Protobuf::Empty
+              # Gets the metadata and configuration for a Field.
+              rpc :GetField, Google::Cloud::Firestore::Admin::V1::GetFieldRequest, Google::Cloud::Firestore::Admin::V1::Field
+              # Updates a field configuration. Currently, field updates apply only to
+              # single field index configuration. However, calls to
+              # [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid
+              # changing any configuration that the caller isn't aware of. The field mask
+              # should be specified as: `{ paths: "index_config" }`.
+              #
+              # This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to
+              # track the status of the field update. The metadata for
+              # the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
+              #
+              # To configure the default field settings for the database, use
+              # the special `Field` with resource name:
+              # `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
+              rpc :UpdateField, Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest, Google::Longrunning::Operation
+              # Lists the field configuration and metadata for this database.
+              #
+              # Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
+              # that have been explicitly overridden. To issue this query, call
+              # [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
+              # `indexConfig.usesAncestorConfig:false`.
+              rpc :ListFields, Google::Cloud::Firestore::Admin::V1::ListFieldsRequest, Google::Cloud::Firestore::Admin::V1::ListFieldsResponse
+              # Exports a copy of all or a subset of documents from Google Cloud Firestore
+              # to another storage system, such as Google Cloud Storage. Recent updates to
+              # documents may not be reflected in the export. The export occurs in the
+              # background and its progress can be monitored and managed via the
+              # Operation resource that is created. The output of an export may only be
+              # used once the associated operation is done. If an export operation is
+              # cancelled before completion it may leave partial data behind in Google
+              # Cloud Storage.
+              rpc :ExportDocuments, Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest, Google::Longrunning::Operation
+              # Imports documents into Google Cloud Firestore. Existing documents with the
+              # same name are overwritten. The import occurs in the background and its
+              # progress can be monitored and managed via the Operation resource that is
+              # created. If an ImportDocuments operation is cancelled, it is possible
+              # that a subset of the data has already been imported to Cloud Firestore.
+              rpc :ImportDocuments, Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest, Google::Longrunning::Operation
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/firestore/admin/v1/index_pb.rb

@@ -0,0 +1,61 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/firestore/admin/v1/index.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/firestore/admin/v1/index.proto", :syntax => :proto3) do
+    add_message "google.firestore.admin.v1.Index" do
+      optional :name, :string, 1
+      optional :query_scope, :enum, 2, "google.firestore.admin.v1.Index.QueryScope"
+      repeated :fields, :message, 3, "google.firestore.admin.v1.Index.IndexField"
+      optional :state, :enum, 4, "google.firestore.admin.v1.Index.State"
+    end
+    add_message "google.firestore.admin.v1.Index.IndexField" do
+      optional :field_path, :string, 1
+      oneof :value_mode do
+        optional :order, :enum, 2, "google.firestore.admin.v1.Index.IndexField.Order"
+        optional :array_config, :enum, 3, "google.firestore.admin.v1.Index.IndexField.ArrayConfig"
+      end
+    end
+    add_enum "google.firestore.admin.v1.Index.IndexField.Order" do
+      value :ORDER_UNSPECIFIED, 0
+      value :ASCENDING, 1
+      value :DESCENDING, 2
+    end
+    add_enum "google.firestore.admin.v1.Index.IndexField.ArrayConfig" do
+      value :ARRAY_CONFIG_UNSPECIFIED, 0
+      value :CONTAINS, 1
+    end
+    add_enum "google.firestore.admin.v1.Index.QueryScope" do
+      value :QUERY_SCOPE_UNSPECIFIED, 0
+      value :COLLECTION, 1
+      value :COLLECTION_GROUP, 2
+    end
+    add_enum "google.firestore.admin.v1.Index.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :READY, 2
+      value :NEEDS_REPAIR, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          Index = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index").msgclass
+          Index::IndexField = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField").msgclass
+          Index::IndexField::Order = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.Order").enummodule
+          Index::IndexField::ArrayConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.ArrayConfig").enummodule
+          Index::QueryScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.QueryScope").enummodule
+          Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.State").enummodule
+        end
+      end
+    end
+  end
+end

data/lib/google/firestore/admin/v1/location_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/firestore/admin/v1/location.proto
+
+require 'google/protobuf'
+
+require 'google/type/latlng_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/firestore/admin/v1/location.proto", :syntax => :proto3) do
+    add_message "google.firestore.admin.v1.LocationMetadata" do
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          LocationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.LocationMetadata").msgclass
+        end
+      end
+    end
+  end
+end