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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57ac7b3785adf8f1e43707d5450e8d806780aa70aae7089d25ac8d774312aec5
-  data.tar.gz: b545276711f57102c05622117accef8064cf094c2779d432a41a0927dba3ab80
+  metadata.gz: 0bc700baa2a55a0bbec499e27819be1442c8e2c612eb377687d7f2c2e8726897
+  data.tar.gz: d228fffb8b9b3c254e48de952f99d2d2da33f10df4490118933c551ae8a49679
 SHA512:
-  metadata.gz: 9f0d68dd51a8c96be02be5f197dae2440c07231fe17cf28d0c116f9b990ca97d11e4c1614a5ea453af69f4865a4333b98333a1c8bda5d2881235c7835ae3ac83
-  data.tar.gz: 9b04fa863bb15308224ea4c6aea035116da46c5db6362da95dcb89f2fef0ee91ea7a51f9d0480bca168ab48358a93c90627244e120c871203b688d29518078a0
+  metadata.gz: 4562372f59d7a484b28d08af26da909ea8ebd018135e673938cb78a3a6b1e15005c74a0c6c73ff16ccfdd8f6a1d7a2103b5386927eb42419b88ebf3c6c42d5d9
+  data.tar.gz: 9993403fa72b26c7c85704c846ac2da78d8d1d28b5c49ed9c0635a2045319264a0ca1425c409aa8d5cd0bf05aa07c4cd725beabe299bcf632bed945794253b80

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest.new # (reque
 response = client.create_index request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-firestore-admin-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/firestore)
@@ -69,6 +69,11 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.5+.

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

@@ -22,7 +22,7 @@ module Google
     module Firestore
       module Admin
         module V1
-          VERSION = "0.4.0"
+          VERSION = "0.5.0"
         end
       end
     end

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

@@ -26,6 +26,8 @@ module Google
         ##
         # To load this package, including all its services, and instantiate a client:
         #
+        # @example
+        #
         #     require "google/cloud/firestore/admin/v1"
         #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
         #

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

@@ -1,12 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/firestore/admin/v1/database.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
-require 'google/protobuf/duration_pb'
-require 'google/protobuf/timestamp_pb'
-require 'google/api/annotations_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/firestore/admin/v1/database.proto", :syntax => :proto3) do
@@ -15,6 +13,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :location_id, :string, 9
       optional :type, :enum, 10, "google.firestore.admin.v1.Database.DatabaseType"
       optional :concurrency_mode, :enum, 15, "google.firestore.admin.v1.Database.ConcurrencyMode"
+      optional :app_engine_integration_mode, :enum, 19, "google.firestore.admin.v1.Database.AppEngineIntegrationMode"
+      optional :key_prefix, :string, 20
       optional :etag, :string, 99
     end
     add_enum "google.firestore.admin.v1.Database.DatabaseType" do
@@ -28,6 +28,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :PESSIMISTIC, 2
       value :OPTIMISTIC_WITH_ENTITY_GROUPS, 3
     end
+    add_enum "google.firestore.admin.v1.Database.AppEngineIntegrationMode" do
+      value :APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED, 0
+      value :ENABLED, 1
+      value :DISABLED, 2
+    end
   end
 end
 
@@ -39,6 +44,7 @@ module Google
           Database = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database").msgclass
           Database::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.DatabaseType").enummodule
           Database::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.ConcurrencyMode").enummodule
+          Database::AppEngineIntegrationMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.AppEngineIntegrationMode").enummodule
         end
       end
     end

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

@@ -1,17 +1,18 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/firestore/admin/v1/field.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/firestore/admin/v1/index_pb'
-require 'google/api/annotations_pb'
-require 'google/protobuf'
 
 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"
+      optional :ttl_config, :message, 3, "google.firestore.admin.v1.Field.TtlConfig"
     end
     add_message "google.firestore.admin.v1.Field.IndexConfig" do
       repeated :indexes, :message, 1, "google.firestore.admin.v1.Index"
@@ -19,6 +20,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :ancestor_field, :string, 3
       optional :reverting, :bool, 4
     end
+    add_message "google.firestore.admin.v1.Field.TtlConfig" do
+      optional :state, :enum, 1, "google.firestore.admin.v1.Field.TtlConfig.State"
+    end
+    add_enum "google.firestore.admin.v1.Field.TtlConfig.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :CREATING, 1
+      value :ACTIVE, 2
+      value :NEEDS_REPAIR, 3
+    end
   end
 end
 
@@ -29,6 +39,8 @@ module Google
         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
+          Field::TtlConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Field.TtlConfig").msgclass
+          Field::TtlConfig::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Field.TtlConfig.State").enummodule
         end
       end
     end

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

@@ -1,6 +1,8 @@
 # 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'
@@ -8,12 +10,9 @@ require 'google/api/resource_pb'
 require 'google/firestore/admin/v1/database_pb'
 require 'google/firestore/admin/v1/field_pb'
 require 'google/firestore/admin/v1/index_pb'
-require 'google/firestore/admin/v1/operation_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
-require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/firestore/admin/v1/firestore_admin.proto", :syntax => :proto3) do

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/firestore/admin/v1/index.proto
 
-require 'google/api/resource_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
+require 'google/api/resource_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

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/firestore/admin/v1/location.proto
 
-require 'google/type/latlng_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/firestore/admin/v1/operation.proto
 
+require 'google/protobuf'
+
 require 'google/firestore/admin/v1/index_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/api/annotations_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/firestore/admin/v1/operation.proto", :syntax => :proto3) do
@@ -24,6 +24,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :state, :enum, 5, "google.firestore.admin.v1.OperationState"
       optional :progress_documents, :message, 6, "google.firestore.admin.v1.Progress"
       optional :progress_bytes, :message, 7, "google.firestore.admin.v1.Progress"
+      optional :ttl_config_delta, :message, 8, "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta"
     end
     add_message "google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta" do
       optional :change_type, :enum, 1, "google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType"
@@ -34,6 +35,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :ADD, 1
       value :REMOVE, 2
     end
+    add_message "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta" do
+      optional :change_type, :enum, 1, "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType"
+    end
+    add_enum "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType" do
+      value :CHANGE_TYPE_UNSPECIFIED, 0
+      value :ADD, 1
+      value :REMOVE, 2
+    end
     add_message "google.firestore.admin.v1.ExportDocumentsMetadata" do
       optional :start_time, :message, 1, "google.protobuf.Timestamp"
       optional :end_time, :message, 2, "google.protobuf.Timestamp"
@@ -81,6 +90,8 @@ module Google
           FieldOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.FieldOperationMetadata").msgclass
           FieldOperationMetadata::IndexConfigDelta = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta").msgclass
           FieldOperationMetadata::IndexConfigDelta::ChangeType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType").enummodule
+          FieldOperationMetadata::TtlConfigDelta = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta").msgclass
+          FieldOperationMetadata::TtlConfigDelta::ChangeType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType").enummodule
           ExportDocumentsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ExportDocumentsMetadata").msgclass
           ImportDocumentsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ImportDocumentsMetadata").msgclass
           ExportDocumentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ExportDocumentsResponse").msgclass

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

@@ -41,6 +41,18 @@ module Google
           # @!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
@@ -53,6 +65,8 @@ module Google
             # 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
@@ -69,20 +83,40 @@ module Google
               # Not used.
               CONCURRENCY_MODE_UNSPECIFIED = 0
 
-              # Use optimistic concurrency control by default. This setting is available
-              # for Cloud Firestore customers.
+              # Use optimistic concurrency control by default. This mode is available
+              # for Cloud Firestore databases.
               OPTIMISTIC = 1
 
-              # Use pessimistic concurrency control by default. This setting is available
-              # for Cloud Firestore customers.
+              # 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 setting for Cloud Datastore customers.
-              # This is the default setting for Cloud Datastore.
+              # 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

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

@@ -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/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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -200,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
@@ -220,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+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