google-cloud-firestore-admin-v1 1.5.0 → 1.7.0

data/proto_docs/google/api/routing.rb

@@ -0,0 +1,459 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+    # Specifies the routing information that should be sent along with the request
+    # in the form of routing header.
+    # **NOTE:** All service configuration rules follow the "last one wins" order.
+    #
+    # The examples below will apply to an RPC which has the following request type:
+    #
+    # Message Definition:
+    #
+    #     message Request {
+    #       // The name of the Table
+    #       // Values can be of the following formats:
+    #       // - `projects/<project>/tables/<table>`
+    #       // - `projects/<project>/instances/<instance>/tables/<table>`
+    #       // - `region/<region>/zones/<zone>/tables/<table>`
+    #       string table_name = 1;
+    #
+    #       // This value specifies routing for replication.
+    #       // It can be in the following formats:
+    #       // - `profiles/<profile_id>`
+    #       // - a legacy `profile_id` that can be any string
+    #       string app_profile_id = 2;
+    #     }
+    #
+    # Example message:
+    #
+    #     {
+    #       table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
+    #       app_profile_id: profiles/prof_qux
+    #     }
+    #
+    # The routing header consists of one or multiple key-value pairs. Every key
+    # and value must be percent-encoded, and joined together in the format of
+    # `key1=value1&key2=value2`.
+    # The examples below skip the percent-encoding for readability.
+    #
+    # Example 1
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key equal to the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: app_profile_id=profiles/prof_qux
+    #
+    # Example 2
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key different from the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`, but name it `routing_id` in the header.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 3
+    #
+    # Extracting a field from the request to put into the routing
+    # header, while matching a path template syntax on the field's value.
+    #
+    # NB: it is more useful to send nothing than to send garbage for the purpose
+    # of dynamic routing, since garbage pollutes cache. Thus the matching.
+    #
+    # Sub-example 3a
+    #
+    # The field matches the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with project-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Sub-example 3b
+    #
+    # The field does not match the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with region-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     <no routing header will be sent>
+    #
+    # Sub-example 3c
+    #
+    # Multiple alternative conflictingly named path templates are
+    # specified. The one that matches is used to construct the header.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed, whether
+    #       // using the region- or projects-based syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Example 4
+    #
+    # Extracting a single routing header key-value pair by matching a
+    # template syntax on (a part of) a single request field.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take just the project id from the `table_name` field.
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=projects/proj_foo
+    #
+    # Example 5
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on (parts of) a single request
+    # field. The last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // If the `table_name` does not have instances information,
+    #       // take just the project id for routing.
+    #       // Otherwise take project + instance.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*/instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     routing_id=projects/proj_foo/instances/instance_bar
+    #
+    # Example 6
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several non-conflicting path templates on (parts of) a single request field.
+    #
+    # Sub-example 6a
+    #
+    # Make the templates strict, so that if the `table_name` does not
+    # have an instance information, nothing is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code needs two keys instead of one composite
+    #       // but works only for the tables with the "project-instance" name
+    #       // syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/instances/*/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Sub-example 6b
+    #
+    # Make the templates loose, so that if the `table_name` does not
+    # have an instance information, just the project id part is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code wants two keys instead of one composite
+    #       // but will work with just the `project_id` for tables without
+    #       // an instance in the `table_name`.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result (is the same as 6a for our example message because it has the instance
+    # information):
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Example 7
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several path templates on multiple request fields.
+    #
+    # NB: note that here there is no way to specify sending nothing if one of the
+    # fields does not match its template. E.g. if the `table_name` is in the wrong
+    # format, the `project_id` will not be sent, but the `routing_id` will be.
+    # The backend routing code has to be aware of that and be prepared to not
+    # receive a full complement of keys if it expects multiple.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing needs both `project_id` and `routing_id`
+    #       // (from the `app_profile_id` field) for routing.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&routing_id=profiles/prof_qux
+    #
+    # Example 8
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on several request fields. The
+    # last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The `routing_id` can be a project id or a region id depending on
+    #       // the table name format, but only if the `app_profile_id` is not set.
+    #       // If `app_profile_id` is set it should be used instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #          field: "table_name"
+    #          path_template: "{routing_id=regions/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 9
+    #
+    # Bringing it all together.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // For routing both `table_location` and a `routing_id` are needed.
+    #       //
+    #       // table_location can be either an instance id or a region+zone id.
+    #       //
+    #       // For `routing_id`, take the value of `app_profile_id`
+    #       // - If it's in the format `profiles/<profile_id>`, send
+    #       // just the `<profile_id>` part.
+    #       // - If it's any other literal, send it as is.
+    #       // If the `app_profile_id` is empty, and the `table_name` starts with
+    #       // the project_id, send that instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_location=regions/*/zones/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "profiles/{routing_id=*}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_location=instances/instance_bar&routing_id=prof_qux
+    # @!attribute [rw] routing_parameters
+    #   @return [::Array<::Google::Api::RoutingParameter>]
+    #     A collection of Routing Parameter specifications.
+    #     **NOTE:** If multiple Routing Parameters describe the same key
+    #     (via the `path_template` field or via the `field` field when
+    #     `path_template` is not provided), "last one wins" rule
+    #     determines which Parameter gets used.
+    #     See the examples for more details.
+    class RoutingRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A projection from an input message to the GRPC or REST header.
+    # @!attribute [rw] field
+    #   @return [::String]
+    #     A request field to extract the header key-value pair from.
+    # @!attribute [rw] path_template
+    #   @return [::String]
+    #     A pattern matching the key-value field. Optional.
+    #     If not specified, the whole field specified in the `field` field will be
+    #     taken as value, and its name used as key. If specified, it MUST contain
+    #     exactly one named segment (along with any number of unnamed segments) The
+    #     pattern will be matched over the field specified in the `field` field, then
+    #     if the match is successful:
+    #     - the name of the single named segment will be used as a header name,
+    #     - the match value of the segment will be used as a header value;
+    #     if the match is NOT successful, nothing will be sent.
+    #
+    #     Example:
+    #
+    #                   -- This is a field in the request message
+    #                  |   that the header value will be extracted from.
+    #                  |
+    #                  |                     -- This is the key name in the
+    #                  |                    |   routing header.
+    #                  V                    |
+    #         field: "table_name"           v
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #                                                    ^            ^
+    #                                                    |            |
+    #           In the {} brackets is the pattern that --             |
+    #           specifies what to extract from the                    |
+    #           field as a value to be sent.                          |
+    #                                                                 |
+    #          The string in the field must match the whole pattern --
+    #          before brackets, inside brackets, after brackets.
+    #
+    #     When looking at this specific example, we can see that:
+    #     - A key-value pair with the key `table_location`
+    #       and the value matching `instances/*` should be added
+    #       to the x-goog-request-params routing header.
+    #     - The value is extracted from the request message's `table_name` field
+    #       if it matches the full pattern specified:
+    #       `projects/*/instances/*/tables/*`.
+    #
+    #     **NB:** If the `path_template` field is not provided, the key name is
+    #     equal to the field name, and the whole field should be sent as a value.
+    #     This makes the pattern for the field and the value functionally equivalent
+    #     to `**`, and the configuration
+    #
+    #         {
+    #           field: "table_name"
+    #         }
+    #
+    #     is a functionally equivalent shorthand to:
+    #
+    #         {
+    #           field: "table_name"
+    #           path_template: "{table_name=**}"
+    #         }
+    #
+    #     See Example 1 for more details.
+    class RoutingParameter
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -105,6 +105,12 @@ module Google
           # @!attribute [r] source_info
           #   @return [::Google::Cloud::Firestore::Admin::V1::Database::SourceInfo]
           #     Output only. Information about the provenance of this database.
+          # @!attribute [rw] tags
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. Input only. Immutable. Tag keys/values directly bound to this
+          #     resource. For example:
+          #       "123/environment": "production",
+          #       "123/costCenter": "marketing"
           # @!attribute [r] free_tier
           #   @return [::Boolean]
           #     Output only. Background: Free tier is the ability of a Firestore database
@@ -241,6 +247,15 @@ module Google
               end
             end
 
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class TagsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # The type of the database.
             # See https://cloud.google.com/datastore/docs/firestore-or-datastore for
             # information about how to choose.

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

@@ -669,9 +669,75 @@ module Google
           #     If this field is not specified, the restored database will use
           #     the same encryption configuration as the backup, namely
           #     {::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption use_source_encryption}.
+          # @!attribute [rw] tags
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. Immutable. Tags to be bound to the restored database.
+          #
+          #     The tags should be provided in the format of
+          #     `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
           class RestoreDatabaseRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class TagsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The request message for
+          # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#clone_database FirestoreAdmin.CloneDatabase}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The project to clone the database in. Format is
+          #     `projects/{project_id}`.
+          # @!attribute [rw] database_id
+          #   @return [::String]
+          #     Required. The ID to use for the database, which will become the final
+          #     component of the database's resource name. This database ID must not be
+          #     associated with an existing database.
+          #
+          #     This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/
+          #     with first character a letter and the last a letter or a number. Must not
+          #     be UUID-like /[0-9a-f]\\{8}(-[0-9a-f]\\{4})\\{3}-[0-9a-f]\\{12}/.
+          #
+          #     "(default)" database ID is also valid.
+          # @!attribute [rw] pitr_snapshot
+          #   @return [::Google::Cloud::Firestore::Admin::V1::PitrSnapshot]
+          #     Required. Specification of the PITR data to clone from. The source database
+          #     must exist.
+          #
+          #     The cloned database will be created in the same location as the source
+          #     database.
+          # @!attribute [rw] encryption_config
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig]
+          #     Optional. Encryption configuration for the cloned database.
+          #
+          #     If this field is not specified, the cloned database will use
+          #     the same encryption configuration as the source database, namely
+          #     {::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption use_source_encryption}.
+          # @!attribute [rw] tags
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. Immutable. Tags to be bound to the cloned database.
+          #
+          #     The tags should be provided in the format of
+          #     `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
+          class CloneDatabaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class TagsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
         end
       end

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

@@ -275,6 +275,31 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Metadata for the {::Google::Longrunning::Operation long-running operation} from
+          # the [CloneDatabase][google.firestore.admin.v1.CloneDatabase] request.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time the clone was started.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time the clone finished, unset for ongoing clones.
+          # @!attribute [rw] operation_state
+          #   @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
+          #     The operation state of the clone.
+          # @!attribute [rw] database
+          #   @return [::String]
+          #     The name of the database being cloned to.
+          # @!attribute [rw] pitr_snapshot
+          #   @return [::Google::Cloud::Firestore::Admin::V1::PitrSnapshot]
+          #     The snapshot from which this database was cloned.
+          # @!attribute [rw] progress_percentage
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     How far along the clone is as an estimated percentage of remaining time.
+          class CloneDatabaseMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Describes the progress of the operation.
           # Unit of work is generic and must be interpreted based on where
           # {::Google::Cloud::Firestore::Admin::V1::Progress Progress} is used.

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 consistent snapshot of a database at a specific point in time.
+          # A PITR (Point-in-time recovery) snapshot with previous versions of a
+          # database's data is available for every minute up to the associated database's
+          # data retention period. If the PITR feature is enabled, the retention period
+          # is 7 days; otherwise, it is one hour.
+          # @!attribute [rw] database
+          #   @return [::String]
+          #     Required. The name of the database that this was a snapshot of. Format:
+          #     `projects/{project}/databases/{database}`.
+          # @!attribute [r] database_uid
+          #   @return [::String]
+          #     Output only. Public UUID of the database the snapshot was associated with.
+          # @!attribute [rw] snapshot_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Required. Snapshot time of the database.
+          class PitrSnapshot
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Google LLC
@@ -87,12 +87,14 @@ files:
 - lib/google/firestore/admin/v1/location_pb.rb
 - lib/google/firestore/admin/v1/operation_pb.rb
 - lib/google/firestore/admin/v1/schedule_pb.rb
+- lib/google/firestore/admin/v1/snapshot_pb.rb
 - lib/google/firestore/admin/v1/user_creds_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/api/routing.rb
 - proto_docs/google/firestore/admin/v1/backup.rb
 - proto_docs/google/firestore/admin/v1/database.rb
 - proto_docs/google/firestore/admin/v1/field.rb
@@ -101,6 +103,7 @@ files:
 - proto_docs/google/firestore/admin/v1/location.rb
 - proto_docs/google/firestore/admin/v1/operation.rb
 - proto_docs/google/firestore/admin/v1/schedule.rb
+- proto_docs/google/firestore/admin/v1/snapshot.rb
 - proto_docs/google/firestore/admin/v1/user_creds.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
@@ -128,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Accesses the NoSQL document database built for automatic scaling, high performance,
   and ease of application development.