google-cloud-firestore-admin-v1 0.3.4 → 0.5.0

data/proto_docs/google/firestore/admin/v1/database.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+          # A Cloud Firestore Database.
+          # Currently only one database is allowed per cloud project; this database
+          # must have a `database_id` of '(default)'.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The resource name of the Database.
+          #     Format: `projects/{project}/databases/{database}`
+          # @!attribute [rw] location_id
+          #   @return [::String]
+          #     The location of the database. Available databases are listed at
+          #     https://cloud.google.com/firestore/docs/locations.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database::DatabaseType]
+          #     The type of the database.
+          #     See https://cloud.google.com/datastore/docs/firestore-or-datastore for
+          #     information about how to choose.
+          # @!attribute [rw] concurrency_mode
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode]
+          #     The concurrency control mode to use for this database.
+          # @!attribute [rw] app_engine_integration_mode
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database::AppEngineIntegrationMode]
+          #     The App Engine integration mode to use for this database.
+          # @!attribute [r] key_prefix
+          #   @return [::String]
+          #     Output only. The key_prefix for this database. This key_prefix is used, in combination
+          #     with the project id ("<key prefix>~<project id>") to construct the
+          #     application id that is returned from the Cloud Datastore APIs in Google App
+          #     Engine first generation runtimes.
+          #
+          #     This value may be empty in which case the appid to use for URL-encoded keys
+          #     is the project_id (eg: foo instead of v~foo).
+          # @!attribute [rw] etag
+          #   @return [::String]
+          #     This checksum is computed by the server based on the value of other
+          #     fields, and may be sent on update and delete requests to ensure the
+          #     client has an up-to-date value before proceeding.
+          class Database
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the database.
+            # See https://cloud.google.com/datastore/docs/firestore-or-datastore for
+            # information about how to choose.
+            #
+            # Mode changes are only allowed if the database is empty.
+            module DatabaseType
+              # The default value. This value is used if the database type is omitted.
+              DATABASE_TYPE_UNSPECIFIED = 0
+
+              # Firestore Native Mode
+              FIRESTORE_NATIVE = 1
+
+              # Firestore in Datastore Mode.
+              DATASTORE_MODE = 2
+            end
+
+            # The type of concurrency control mode for transactions.
+            module ConcurrencyMode
+              # Not used.
+              CONCURRENCY_MODE_UNSPECIFIED = 0
+
+              # Use optimistic concurrency control by default. This mode is available
+              # for Cloud Firestore databases.
+              OPTIMISTIC = 1
+
+              # Use pessimistic concurrency control by default. This mode is available
+              # for Cloud Firestore databases.
+              #
+              # This is the default setting for Cloud Firestore.
+              PESSIMISTIC = 2
+
+              # Use optimistic concurrency control with entity groups by default.
+              #
+              # This is the only available mode for Cloud Datastore.
+              #
+              # This mode is also available for Cloud Firestore with Datastore Mode but
+              # is not recommended.
+              OPTIMISTIC_WITH_ENTITY_GROUPS = 3
+            end
+
+            # The type of App Engine integration mode.
+            module AppEngineIntegrationMode
+              # Not used.
+              APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED = 0
+
+              # If an App Engine application exists in the same region as this database,
+              # App Engine configuration will impact this database. This includes
+              # disabling of the application & database, as well as disabling writes to
+              # the database.
+              ENABLED = 1
+
+              # Appengine has no affect on the ability of this database to serve
+              # requests.
+              DISABLED = 2
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/admin/v1/field.rb

@@ -28,7 +28,7 @@ module Google
           # collections in the database with the same id.
           # @!attribute [rw] name
           #   @return [::String]
-          #     A field name of the form
+          #     Required. A field name of the form
           #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
           #
           #     A field path may be a simple field name, e.g. `address` or a path to fields
@@ -60,6 +60,11 @@ module Google
           #     revert to the configuration defined by the `ancestor_field`. To
           #     explicitly remove all indexes for this field, specify an index config
           #     with an empty list of indexes.
+          # @!attribute [rw] ttl_config
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig]
+          #     The TTL configuration for this `Field`.
+          #     Setting or unsetting this will enable or disable the TTL for
+          #     documents that have this `Field`.
           class Field
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -90,6 +95,41 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # The TTL (time-to-live) configuration for documents that have this `Field`
+            # set.
+            # Storing a timestamp value into a TTL-enabled field will be treated as
+            # the document's absolute expiration time. Using any other data type or
+            # leaving the field absent will disable the TTL for the individual document.
+            # @!attribute [r] state
+            #   @return [::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State]
+            #     Output only. The state of the TTL configuration.
+            class TtlConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The state of applying the TTL configuration to all documents.
+              module State
+                # The state is unspecified or unknown.
+                STATE_UNSPECIFIED = 0
+
+                # The TTL is being applied. There is an active long-running operation to
+                # track the change. Newly written documents will have TTLs applied as
+                # requested. Requested TTLs on existing documents are still being
+                # processed. When TTLs on all existing documents have been processed, the
+                # state will move to 'ACTIVE'.
+                CREATING = 1
+
+                # The TTL is active for all documents.
+                ACTIVE = 2
+
+                # The TTL configuration could not be enabled for all existing documents.
+                # Newly written documents will continue to have their TTL applied.
+                # The LRO returned when last attempting to enable TTL for this `Field`
+                # has failed, and may have more details.
+                NEEDS_REPAIR = 3
+              end
+            end
           end
         end
       end

data/proto_docs/google/firestore/admin/v1/firestore_admin.rb

@@ -22,6 +22,53 @@ module Google
     module Firestore
       module Admin
         module V1
+          # A request to list the Firestore Databases in all locations for a project.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. A parent name of the form
+          #     `projects/{project_id}`
+          class ListDatabasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The list of databases for a project.
+          # @!attribute [rw] databases
+          #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::Database>]
+          #     The databases in the project.
+          class ListDatabasesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_database FirestoreAdmin.GetDatabase}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. A name of the form
+          #     `projects/{project_id}/databases/{database_id}`
+          class GetDatabaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_database FirestoreAdmin.UpdateDatabase}.
+          # @!attribute [rw] database
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database]
+          #     Required. The database to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The list of fields to be updated.
+          class UpdateDatabaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata related to the update database operation.
+          class UpdateDatabaseMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
           # @!attribute [rw] parent
           #   @return [::String]
@@ -122,8 +169,8 @@ module Google
           #     The filter to apply to list results. Currently,
           #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
           #     that have been explicitly overridden. To issue this query, call
-          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
-          #     `indexConfig.usesAncestorConfig:false`.
+          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with a filter that includes
+          #     `indexConfig.usesAncestorConfig:false` .
           # @!attribute [rw] page_size
           #   @return [::Integer]
           #     The number of results to return.

data/proto_docs/google/firestore/admin/v1/index.rb

@@ -70,7 +70,7 @@ module Google
             # @!attribute [rw] order
             #   @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
             #     Indicates that this field supports ordering by the specified order or
-            #     comparing using =, <, <=, >, >=.
+            #     comparing using =, !=, <, <=, >, >=.
             # @!attribute [rw] array_config
             #   @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
             #     Indicates that this field supports operations on `array_value`s.

data/proto_docs/google/firestore/admin/v1/operation.rb

@@ -75,6 +75,9 @@ module Google
           # @!attribute [rw] progress_bytes
           #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
           #     The progress, in bytes, of this operation.
+          # @!attribute [rw] ttl_config_delta
+          #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta]
+          #     Describes the deltas of TTL configuration.
           class FieldOperationMetadata
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -102,6 +105,27 @@ module Google
                 REMOVE = 2
               end
             end
+
+            # Information about an TTL configuration change.
+            # @!attribute [rw] change_type
+            #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
+            #     Specifies how the TTL configuration is changing.
+            class TtlConfigDelta
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Specifies how the TTL config is changing.
+              module ChangeType
+                # The type of change is not specified or known.
+                CHANGE_TYPE_UNSPECIFIED = 0
+
+                # The TTL config is being added.
+                ADD = 1
+
+                # The TTL config is being removed.
+                REMOVE = 2
+              end
+            end
           end
 
           # Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from

data/proto_docs/google/protobuf/any.rb

@@ -44,7 +44,7 @@ module Google
     #       foo = any.unpack(Foo.class);
     #     }
     #
-    #  Example 3: Pack and unpack a message in Python.
+    # Example 3: Pack and unpack a message in Python.
     #
     #     foo = Foo(...)
     #     any = Any()
@@ -54,7 +54,7 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
-    #  Example 4: Pack and unpack a message in Go
+    # Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
     #      any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
     #
     #
     # JSON
-    # ====
+    #
     # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
     # additional field `@type` which contains the type URL. Example:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -177,6 +177,7 @@ files:
 - lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb
 - lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb
 - lib/google/cloud/firestore/admin/v1/version.rb
+- lib/google/firestore/admin/v1/database_pb.rb
 - lib/google/firestore/admin/v1/field_pb.rb
 - lib/google/firestore/admin/v1/firestore_admin_pb.rb
 - lib/google/firestore/admin/v1/firestore_admin_services_pb.rb
@@ -186,6 +187,7 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/firestore/admin/v1/database.rb
 - proto_docs/google/firestore/admin/v1/field.rb
 - proto_docs/google/firestore/admin/v1/firestore_admin.rb
 - proto_docs/google/firestore/admin/v1/index.rb
@@ -198,7 +200,6 @@ files:
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb
-- proto_docs/google/type/latlng.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
@@ -218,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Firestore Admin V1 API

data/proto_docs/google/type/latlng.rb

@@ -1,38 +0,0 @@
-# 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 Type
-    # An object that represents a latitude/longitude pair. This is expressed as a
-    # pair of doubles to represent degrees latitude and degrees longitude. Unless
-    # specified otherwise, this must conform to the
-    # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
-    # standard</a>. Values must be within normalized ranges.
-    # @!attribute [rw] latitude
-    #   @return [::Float]
-    #     The latitude in degrees. It must be in the range [-90.0, +90.0].
-    # @!attribute [rw] longitude
-    #   @return [::Float]
-    #     The longitude in degrees. It must be in the range [-180.0, +180.0].
-    class LatLng
-      include ::Google::Protobuf::MessageExts
-      extend ::Google::Protobuf::MessageExts::ClassMethods
-    end
-  end
-end