google-cloud-firestore-admin-v1 1.2.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ require 'google/api/field_behavior_pb'
8
8
  require 'google/api/resource_pb'
9
9
 
10
10
 
11
- descriptor_data = "\n%google/firestore/admin/v1/index.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\x91\t\n\x05Index\x12\x0c\n\x04name\x18\x01 \x01(\t\x12@\n\x0bquery_scope\x18\x02 \x01(\x0e\x32+.google.firestore.admin.v1.Index.QueryScope\x12<\n\tapi_scope\x18\x05 \x01(\x0e\x32).google.firestore.admin.v1.Index.ApiScope\x12;\n\x06\x66ields\x18\x03 \x03(\x0b\x32+.google.firestore.admin.v1.Index.IndexField\x12\x35\n\x05state\x18\x04 \x01(\x0e\x32&.google.firestore.admin.v1.Index.State\x1a\xa2\x04\n\nIndexField\x12\x12\n\nfield_path\x18\x01 \x01(\t\x12\x42\n\x05order\x18\x02 \x01(\x0e\x32\x31.google.firestore.admin.v1.Index.IndexField.OrderH\x00\x12O\n\x0c\x61rray_config\x18\x03 \x01(\x0e\x32\x37.google.firestore.admin.v1.Index.IndexField.ArrayConfigH\x00\x12Q\n\rvector_config\x18\x04 \x01(\x0b\x32\x38.google.firestore.admin.v1.Index.IndexField.VectorConfigH\x00\x1a\x8f\x01\n\x0cVectorConfig\x12\x16\n\tdimension\x18\x01 \x01(\x05\x42\x03\xe0\x41\x02\x12R\n\x04\x66lat\x18\x02 \x01(\x0b\x32\x42.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndexH\x00\x1a\x0b\n\tFlatIndexB\x06\n\x04type\"=\n\x05Order\x12\x15\n\x11ORDER_UNSPECIFIED\x10\x00\x12\r\n\tASCENDING\x10\x01\x12\x0e\n\nDESCENDING\x10\x02\"9\n\x0b\x41rrayConfig\x12\x1c\n\x18\x41RRAY_CONFIG_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43ONTAINS\x10\x01\x42\x0c\n\nvalue_mode\"i\n\nQueryScope\x12\x1b\n\x17QUERY_SCOPE_UNSPECIFIED\x10\x00\x12\x0e\n\nCOLLECTION\x10\x01\x12\x14\n\x10\x43OLLECTION_GROUP\x10\x02\x12\x18\n\x14\x43OLLECTION_RECURSIVE\x10\x03\"/\n\x08\x41piScope\x12\x0b\n\x07\x41NY_API\x10\x00\x12\x16\n\x12\x44\x41TASTORE_MODE_API\x10\x01\"I\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43REATING\x10\x01\x12\t\n\x05READY\x10\x02\x12\x10\n\x0cNEEDS_REPAIR\x10\x03:z\xea\x41w\n\x1e\x66irestore.googleapis.com/Index\x12Uprojects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}B\xd9\x01\n\x1d\x63om.google.firestore.admin.v1B\nIndexProtoP\x01Z9cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb\xa2\x02\x04GCFS\xaa\x02\x1fGoogle.Cloud.Firestore.Admin.V1\xca\x02\x1fGoogle\\Cloud\\Firestore\\Admin\\V1\xea\x02#Google::Cloud::Firestore::Admin::V1b\x06proto3"
11
+ descriptor_data = "\n%google/firestore/admin/v1/index.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\xed\n\n\x05Index\x12\x0c\n\x04name\x18\x01 \x01(\t\x12@\n\x0bquery_scope\x18\x02 \x01(\x0e\x32+.google.firestore.admin.v1.Index.QueryScope\x12<\n\tapi_scope\x18\x05 \x01(\x0e\x32).google.firestore.admin.v1.Index.ApiScope\x12;\n\x06\x66ields\x18\x03 \x03(\x0b\x32+.google.firestore.admin.v1.Index.IndexField\x12\x35\n\x05state\x18\x04 \x01(\x0e\x32&.google.firestore.admin.v1.Index.State\x12>\n\x07\x64\x65nsity\x18\x06 \x01(\x0e\x32(.google.firestore.admin.v1.Index.DensityB\x03\xe0\x41\x05\x12\x15\n\x08multikey\x18\x07 \x01(\x08\x42\x03\xe0\x41\x01\x12\x18\n\x0bshard_count\x18\x08 \x01(\x05\x42\x03\xe0\x41\x01\x1a\xa2\x04\n\nIndexField\x12\x12\n\nfield_path\x18\x01 \x01(\t\x12\x42\n\x05order\x18\x02 \x01(\x0e\x32\x31.google.firestore.admin.v1.Index.IndexField.OrderH\x00\x12O\n\x0c\x61rray_config\x18\x03 \x01(\x0e\x32\x37.google.firestore.admin.v1.Index.IndexField.ArrayConfigH\x00\x12Q\n\rvector_config\x18\x04 \x01(\x0b\x32\x38.google.firestore.admin.v1.Index.IndexField.VectorConfigH\x00\x1a\x8f\x01\n\x0cVectorConfig\x12\x16\n\tdimension\x18\x01 \x01(\x05\x42\x03\xe0\x41\x02\x12R\n\x04\x66lat\x18\x02 \x01(\x0b\x32\x42.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndexH\x00\x1a\x0b\n\tFlatIndexB\x06\n\x04type\"=\n\x05Order\x12\x15\n\x11ORDER_UNSPECIFIED\x10\x00\x12\r\n\tASCENDING\x10\x01\x12\x0e\n\nDESCENDING\x10\x02\"9\n\x0b\x41rrayConfig\x12\x1c\n\x18\x41RRAY_CONFIG_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43ONTAINS\x10\x01\x42\x0c\n\nvalue_mode\"i\n\nQueryScope\x12\x1b\n\x17QUERY_SCOPE_UNSPECIFIED\x10\x00\x12\x0e\n\nCOLLECTION\x10\x01\x12\x14\n\x10\x43OLLECTION_GROUP\x10\x02\x12\x18\n\x14\x43OLLECTION_RECURSIVE\x10\x03\"K\n\x08\x41piScope\x12\x0b\n\x07\x41NY_API\x10\x00\x12\x16\n\x12\x44\x41TASTORE_MODE_API\x10\x01\x12\x1a\n\x16MONGODB_COMPATIBLE_API\x10\x02\"I\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43REATING\x10\x01\x12\t\n\x05READY\x10\x02\x12\x10\n\x0cNEEDS_REPAIR\x10\x03\"M\n\x07\x44\x65nsity\x12\x17\n\x13\x44\x45NSITY_UNSPECIFIED\x10\x00\x12\x0e\n\nSPARSE_ALL\x10\x01\x12\x0e\n\nSPARSE_ANY\x10\x02\x12\t\n\x05\x44\x45NSE\x10\x03:z\xea\x41w\n\x1e\x66irestore.googleapis.com/Index\x12Uprojects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}B\xd9\x01\n\x1d\x63om.google.firestore.admin.v1B\nIndexProtoP\x01Z9cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb\xa2\x02\x04GCFS\xaa\x02\x1fGoogle.Cloud.Firestore.Admin.V1\xca\x02\x1fGoogle\\Cloud\\Firestore\\Admin\\V1\xea\x02#Google::Cloud::Firestore::Admin::V1b\x06proto3"
12
12
 
13
13
  pool = Google::Protobuf::DescriptorPool.generated_pool
14
14
 
@@ -48,6 +48,7 @@ module Google
48
48
  Index::QueryScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.QueryScope").enummodule
49
49
  Index::ApiScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.ApiScope").enummodule
50
50
  Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.State").enummodule
51
+ Index::Density = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.Density").enummodule
51
52
  end
52
53
  end
53
54
  end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
3
+ # source: google/firestore/admin/v1/user_creds.proto
4
+
5
+ require 'google/protobuf'
6
+
7
+ require 'google/api/field_behavior_pb'
8
+ require 'google/api/resource_pb'
9
+ require 'google/protobuf/timestamp_pb'
10
+
11
+
12
+ descriptor_data = "\n*google/firestore/admin/v1/user_creds.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xb7\x04\n\tUserCreds\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12>\n\x05state\x18\x04 \x01(\x0e\x32*.google.firestore.admin.v1.UserCreds.StateB\x03\xe0\x41\x03\x12\x1c\n\x0fsecure_password\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12R\n\x11resource_identity\x18\x06 \x01(\x0b\x32\x35.google.firestore.admin.v1.UserCreds.ResourceIdentityH\x00\x1a*\n\x10ResourceIdentity\x12\x16\n\tprincipal\x18\x01 \x01(\tB\x03\xe0\x41\x03\"9\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02:}\xea\x41z\n\"firestore.googleapis.com/UserCreds\x12>projects/{project}/databases/{database}/userCreds/{user_creds}*\tuserCreds2\tuserCredsB\x13\n\x11UserCredsIdentityB\xdd\x01\n\x1d\x63om.google.firestore.admin.v1B\x0eUserCredsProtoP\x01Z9cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb\xa2\x02\x04GCFS\xaa\x02\x1fGoogle.Cloud.Firestore.Admin.V1\xca\x02\x1fGoogle\\Cloud\\Firestore\\Admin\\V1\xea\x02#Google::Cloud::Firestore::Admin::V1b\x06proto3"
13
+
14
+ pool = Google::Protobuf::DescriptorPool.generated_pool
15
+
16
+ begin
17
+ pool.add_serialized_file(descriptor_data)
18
+ rescue TypeError
19
+ # Compatibility code: will be removed in the next major version.
20
+ require 'google/protobuf/descriptor_pb'
21
+ parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
22
+ parsed.clear_dependency
23
+ serialized = parsed.class.encode(parsed)
24
+ file = pool.add_serialized_file(serialized)
25
+ warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
26
+ imports = [
27
+ ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
28
+ ]
29
+ imports.each do |type_name, expected_filename|
30
+ import_file = pool.lookup(type_name).file_descriptor
31
+ if import_file.name != expected_filename
32
+ warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
33
+ end
34
+ end
35
+ warn "Each proto file must use a consistent fully-qualified name."
36
+ warn "This will become an error in the next major version."
37
+ end
38
+
39
+ module Google
40
+ module Cloud
41
+ module Firestore
42
+ module Admin
43
+ module V1
44
+ UserCreds = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UserCreds").msgclass
45
+ UserCreds::ResourceIdentity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UserCreds.ResourceIdentity").msgclass
46
+ UserCreds::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UserCreds.State").enummodule
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -221,6 +221,12 @@ module Google
221
221
  # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
222
  # enabled by default 1 month after launching the feature in preview
223
223
  # packages.
224
+ # @!attribute [rw] unversioned_package_disabled
225
+ # @return [::Boolean]
226
+ # Disables generation of an unversioned Python package for this client
227
+ # library. This means that the module names will need to be versioned in
228
+ # import statements. For example `import google.cloud.library_v2` instead
229
+ # of `import google.cloud.library`.
224
230
  class ExperimentalFeatures
225
231
  include ::Google::Protobuf::MessageExts
226
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -409,6 +415,14 @@ module Google
409
415
  # @return [::Array<::String>]
410
416
  # An allowlist of the fully qualified names of RPCs that should be included
411
417
  # on public client surfaces.
418
+ # @!attribute [rw] generate_omitted_as_internal
419
+ # @return [::Boolean]
420
+ # Setting this to true indicates to the client generators that methods
421
+ # that would be excluded from the generation should instead be generated
422
+ # in a way that indicates these methods should not be consumed by
423
+ # end users. How this is expressed is up to individual language
424
+ # implementations to decide. Some examples may be: added annotations,
425
+ # obfuscated identifiers, or other language idiomatic patterns.
412
426
  class SelectiveGapicGeneration
413
427
  include ::Google::Protobuf::MessageExts
414
428
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -105,11 +105,27 @@ module Google
105
105
  # @!attribute [r] source_info
106
106
  # @return [::Google::Cloud::Firestore::Admin::V1::Database::SourceInfo]
107
107
  # Output only. Information about the provenance of this database.
108
+ # @!attribute [r] free_tier
109
+ # @return [::Boolean]
110
+ # Output only. Background: Free tier is the ability of a Firestore database
111
+ # to use a small amount of resources every day without being charged. Once
112
+ # usage exceeds the free tier limit further usage is charged.
113
+ #
114
+ # Whether this database can make use of the free tier. Only one database
115
+ # per project can be eligible for the free tier.
116
+ #
117
+ # The first (or next) database that is created in a project without a free
118
+ # tier database will be marked as eligible for the free tier. Databases that
119
+ # are created while there is a free tier database will not be eligible for
120
+ # the free tier.
108
121
  # @!attribute [rw] etag
109
122
  # @return [::String]
110
123
  # This checksum is computed by the server based on the value of other
111
124
  # fields, and may be sent on update and delete requests to ensure the
112
125
  # client has an up-to-date value before proceeding.
126
+ # @!attribute [rw] database_edition
127
+ # @return [::Google::Cloud::Firestore::Admin::V1::Database::DatabaseEdition]
128
+ # Immutable. The edition of the database.
113
129
  class Database
114
130
  include ::Google::Protobuf::MessageExts
115
131
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -176,12 +192,18 @@ module Google
176
192
  # @!attribute [rw] google_default_encryption
177
193
  # @return [::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::GoogleDefaultEncryptionOptions]
178
194
  # Use Google default encryption.
195
+ #
196
+ # Note: The following fields are mutually exclusive: `google_default_encryption`, `use_source_encryption`, `customer_managed_encryption`. If a field in that set is populated, all other fields in the set will automatically be cleared.
179
197
  # @!attribute [rw] use_source_encryption
180
198
  # @return [::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::SourceEncryptionOptions]
181
199
  # The database will use the same encryption configuration as the source.
200
+ #
201
+ # Note: The following fields are mutually exclusive: `use_source_encryption`, `google_default_encryption`, `customer_managed_encryption`. If a field in that set is populated, all other fields in the set will automatically be cleared.
182
202
  # @!attribute [rw] customer_managed_encryption
183
203
  # @return [::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::CustomerManagedEncryptionOptions]
184
204
  # Use Customer Managed Encryption Keys (CMEK) for encryption.
205
+ #
206
+ # Note: The following fields are mutually exclusive: `customer_managed_encryption`, `google_default_encryption`, `use_source_encryption`. If a field in that set is populated, all other fields in the set will automatically be cleared.
185
207
  class EncryptionConfig
186
208
  include ::Google::Protobuf::MessageExts
187
209
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -308,6 +330,20 @@ module Google
308
330
  # Delete protection is enabled
309
331
  DELETE_PROTECTION_ENABLED = 2
310
332
  end
333
+
334
+ # The edition of the database.
335
+ module DatabaseEdition
336
+ # Not used.
337
+ DATABASE_EDITION_UNSPECIFIED = 0
338
+
339
+ # Standard edition.
340
+ #
341
+ # This is the default setting if not specified.
342
+ STANDARD = 1
343
+
344
+ # Enterprise edition.
345
+ ENTERPRISE = 2
346
+ end
311
347
  end
312
348
  end
313
349
  end
@@ -137,6 +137,104 @@ module Google
137
137
  extend ::Google::Protobuf::MessageExts::ClassMethods
138
138
  end
139
139
 
140
+ # The request for
141
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_user_creds FirestoreAdmin.CreateUserCreds}.
142
+ # @!attribute [rw] parent
143
+ # @return [::String]
144
+ # Required. A parent name of the form
145
+ # `projects/{project_id}/databases/{database_id}`
146
+ # @!attribute [rw] user_creds
147
+ # @return [::Google::Cloud::Firestore::Admin::V1::UserCreds]
148
+ # Required. The user creds to create.
149
+ # @!attribute [rw] user_creds_id
150
+ # @return [::String]
151
+ # Required. The ID to use for the user creds, which will become the final
152
+ # component of the user creds's resource name.
153
+ #
154
+ # This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/
155
+ # with first character a letter and the last a letter or a number. Must not
156
+ # be UUID-like /[0-9a-f]\\{8}(-[0-9a-f]\\{4})\\{3}-[0-9a-f]\\{12}/.
157
+ class CreateUserCredsRequest
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # The request for
163
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_user_creds FirestoreAdmin.GetUserCreds}.
164
+ # @!attribute [rw] name
165
+ # @return [::String]
166
+ # Required. A name of the form
167
+ # `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
168
+ class GetUserCredsRequest
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # The request for
174
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_user_creds FirestoreAdmin.ListUserCreds}.
175
+ # @!attribute [rw] parent
176
+ # @return [::String]
177
+ # Required. A parent database name of the form
178
+ # `projects/{project_id}/databases/{database_id}`
179
+ class ListUserCredsRequest
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # The response for
185
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_user_creds FirestoreAdmin.ListUserCreds}.
186
+ # @!attribute [rw] user_creds
187
+ # @return [::Array<::Google::Cloud::Firestore::Admin::V1::UserCreds>]
188
+ # The user creds for the database.
189
+ class ListUserCredsResponse
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+ end
193
+
194
+ # The request for
195
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#enable_user_creds FirestoreAdmin.EnableUserCreds}.
196
+ # @!attribute [rw] name
197
+ # @return [::String]
198
+ # Required. A name of the form
199
+ # `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
200
+ class EnableUserCredsRequest
201
+ include ::Google::Protobuf::MessageExts
202
+ extend ::Google::Protobuf::MessageExts::ClassMethods
203
+ end
204
+
205
+ # The request for
206
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#disable_user_creds FirestoreAdmin.DisableUserCreds}.
207
+ # @!attribute [rw] name
208
+ # @return [::String]
209
+ # Required. A name of the form
210
+ # `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
211
+ class DisableUserCredsRequest
212
+ include ::Google::Protobuf::MessageExts
213
+ extend ::Google::Protobuf::MessageExts::ClassMethods
214
+ end
215
+
216
+ # The request for
217
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#reset_user_password FirestoreAdmin.ResetUserPassword}.
218
+ # @!attribute [rw] name
219
+ # @return [::String]
220
+ # Required. A name of the form
221
+ # `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
222
+ class ResetUserPasswordRequest
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+
227
+ # The request for
228
+ # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#delete_user_creds FirestoreAdmin.DeleteUserCreds}.
229
+ # @!attribute [rw] name
230
+ # @return [::String]
231
+ # Required. A name of the form
232
+ # `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
233
+ class DeleteUserCredsRequest
234
+ include ::Google::Protobuf::MessageExts
235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
236
+ end
237
+
140
238
  # The request for
141
239
  # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_backup_schedule FirestoreAdmin.CreateBackupSchedule}.
142
240
  # @!attribute [rw] parent
@@ -489,6 +587,20 @@ module Google
489
587
  # Use `{location} = '-'` to list backups from all locations for the given
490
588
  # project. This allows listing backups from a single location or from all
491
589
  # locations.
590
+ # @!attribute [rw] filter
591
+ # @return [::String]
592
+ # An expression that filters the list of returned backups.
593
+ #
594
+ # A filter expression consists of a field name, a comparison operator, and a
595
+ # value for filtering.
596
+ # The value must be a string, a number, or a boolean. The comparison operator
597
+ # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
598
+ # Colon `:` is the contains operator. Filter rules are not case sensitive.
599
+ #
600
+ # The following fields in the {::Google::Cloud::Firestore::Admin::V1::Backup Backup} are
601
+ # eligible for filtering:
602
+ #
603
+ # * `database_uid` (supports `=` only)
492
604
  class ListBackupsRequest
493
605
  include ::Google::Protobuf::MessageExts
494
606
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -58,6 +58,22 @@ module Google
58
58
  # @!attribute [rw] state
59
59
  # @return [::Google::Cloud::Firestore::Admin::V1::Index::State]
60
60
  # Output only. The serving state of the index.
61
+ # @!attribute [rw] density
62
+ # @return [::Google::Cloud::Firestore::Admin::V1::Index::Density]
63
+ # Immutable. The density configuration of the index.
64
+ # @!attribute [rw] multikey
65
+ # @return [::Boolean]
66
+ # Optional. Whether the index is multikey. By default, the index is not
67
+ # multikey. For non-multikey indexes, none of the paths in the index
68
+ # definition reach or traverse an array, except via an explicit array index.
69
+ # For multikey indexes, at most one of the paths in the index definition
70
+ # reach or traverse an array, except via an explicit array index. Violations
71
+ # will result in errors.
72
+ #
73
+ # Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.
74
+ # @!attribute [rw] shard_count
75
+ # @return [::Integer]
76
+ # Optional. The number of shards for the index.
61
77
  class Index
62
78
  include ::Google::Protobuf::MessageExts
63
79
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -74,13 +90,19 @@ module Google
74
90
  # @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
75
91
  # Indicates that this field supports ordering by the specified order or
76
92
  # comparing using =, !=, <, <=, >, >=.
93
+ #
94
+ # Note: The following fields are mutually exclusive: `order`, `array_config`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
77
95
  # @!attribute [rw] array_config
78
96
  # @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
79
97
  # Indicates that this field supports operations on `array_value`s.
98
+ #
99
+ # Note: The following fields are mutually exclusive: `array_config`, `order`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
80
100
  # @!attribute [rw] vector_config
81
101
  # @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig]
82
102
  # Indicates that this field supports nearest neighbor and distance
83
103
  # operations on vector.
104
+ #
105
+ # Note: The following fields are mutually exclusive: `vector_config`, `order`, `array_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
84
106
  class IndexField
85
107
  include ::Google::Protobuf::MessageExts
86
108
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -159,6 +181,9 @@ module Google
159
181
 
160
182
  # The index can only be used by the Firestore in Datastore Mode query API.
161
183
  DATASTORE_MODE_API = 1
184
+
185
+ # The index can only be used by the MONGODB_COMPATIBLE_API.
186
+ MONGODB_COMPATIBLE_API = 2
162
187
  end
163
188
 
164
189
  # The state of an index. During index creation, an index will be in the
@@ -190,6 +215,32 @@ module Google
190
215
  # index.
191
216
  NEEDS_REPAIR = 3
192
217
  end
218
+
219
+ # The density configuration for the index.
220
+ module Density
221
+ # Unspecified. It will use database default setting. This value is input
222
+ # only.
223
+ DENSITY_UNSPECIFIED = 0
224
+
225
+ # In order for an index entry to be added, the document must
226
+ # contain all fields specified in the index.
227
+ #
228
+ # This is the only allowed value for indexes having ApiScope `ANY_API` and
229
+ # `DATASTORE_MODE_API`.
230
+ SPARSE_ALL = 1
231
+
232
+ # In order for an index entry to be added, the document must
233
+ # contain at least one of the fields specified in the index.
234
+ # Non-existent fields are treated as having a NULL value when generating
235
+ # index entries.
236
+ SPARSE_ANY = 2
237
+
238
+ # An index entry will be added regardless of whether the
239
+ # document contains any of the fields specified in the index.
240
+ # Non-existent fields are treated as having a NULL value when generating
241
+ # index entries.
242
+ DENSE = 3
243
+ end
193
244
  end
194
245
  end
195
246
  end
@@ -55,9 +55,13 @@ module Google
55
55
  # @!attribute [rw] daily_recurrence
56
56
  # @return [::Google::Cloud::Firestore::Admin::V1::DailyRecurrence]
57
57
  # For a schedule that runs daily.
58
+ #
59
+ # Note: The following fields are mutually exclusive: `daily_recurrence`, `weekly_recurrence`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
60
  # @!attribute [rw] weekly_recurrence
59
61
  # @return [::Google::Cloud::Firestore::Admin::V1::WeeklyRecurrence]
60
62
  # For a schedule that runs weekly on a specific day.
63
+ #
64
+ # Note: The following fields are mutually exclusive: `weekly_recurrence`, `daily_recurrence`. If a field in that set is populated, all other fields in the set will automatically be cleared.
61
65
  class BackupSchedule
62
66
  include ::Google::Protobuf::MessageExts
63
67
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Firestore
23
+ module Admin
24
+ module V1
25
+ # A Cloud Firestore User Creds.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Identifier. The resource name of the UserCreds.
29
+ # Format:
30
+ # `projects/{project}/databases/{database}/userCreds/{user_creds}`
31
+ # @!attribute [r] create_time
32
+ # @return [::Google::Protobuf::Timestamp]
33
+ # Output only. The time the user creds were created.
34
+ # @!attribute [r] update_time
35
+ # @return [::Google::Protobuf::Timestamp]
36
+ # Output only. The time the user creds were last updated.
37
+ # @!attribute [r] state
38
+ # @return [::Google::Cloud::Firestore::Admin::V1::UserCreds::State]
39
+ # Output only. Whether the user creds are enabled or disabled. Defaults to
40
+ # ENABLED on creation.
41
+ # @!attribute [r] secure_password
42
+ # @return [::String]
43
+ # Output only. The plaintext server-generated password for the user creds.
44
+ # Only populated in responses for CreateUserCreds and ResetUserPassword.
45
+ # @!attribute [rw] resource_identity
46
+ # @return [::Google::Cloud::Firestore::Admin::V1::UserCreds::ResourceIdentity]
47
+ # Resource Identity descriptor.
48
+ class UserCreds
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+
52
+ # Describes a Resource Identity principal.
53
+ # @!attribute [r] principal
54
+ # @return [::String]
55
+ # Output only. Principal identifier string.
56
+ # See: https://cloud.google.com/iam/docs/principal-identifiers
57
+ class ResourceIdentity
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # The state of the user creds (ENABLED or DISABLED).
63
+ module State
64
+ # The default value. Should not be used.
65
+ STATE_UNSPECIFIED = 0
66
+
67
+ # The user creds are enabled.
68
+ ENABLED = 1
69
+
70
+ # The user creds are disabled.
71
+ DISABLED = 2
72
+ end
73
+ end
74
+ end
75
+ end
76
+ end
77
+ end
78
+ end
@@ -40,6 +40,8 @@ module Google
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
42
42
  # The error result of the operation in case of failure or cancellation.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
43
45
  # @!attribute [rw] response
44
46
  # @return [::Google::Protobuf::Any]
45
47
  # The normal, successful response of the operation. If the original
@@ -50,6 +52,8 @@ module Google
50
52
  # is the original method name. For example, if the original method name
51
53
  # is `TakeSnapshot()`, the inferred response type is
52
54
  # `TakeSnapshotResponse`.
55
+ #
56
+ # Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
53
57
  class Operation
54
58
  include ::Google::Protobuf::MessageExts
55
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-admin-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-12-10 00:00:00.000000000 Z
10
+ date: 2025-04-21 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.24.0
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.24.0
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -100,6 +99,7 @@ files:
100
99
  - lib/google/firestore/admin/v1/location_pb.rb
101
100
  - lib/google/firestore/admin/v1/operation_pb.rb
102
101
  - lib/google/firestore/admin/v1/schedule_pb.rb
102
+ - lib/google/firestore/admin/v1/user_creds_pb.rb
103
103
  - proto_docs/README.md
104
104
  - proto_docs/google/api/client.rb
105
105
  - proto_docs/google/api/field_behavior.rb
@@ -113,6 +113,7 @@ files:
113
113
  - proto_docs/google/firestore/admin/v1/location.rb
114
114
  - proto_docs/google/firestore/admin/v1/operation.rb
115
115
  - proto_docs/google/firestore/admin/v1/schedule.rb
116
+ - proto_docs/google/firestore/admin/v1/user_creds.rb
116
117
  - proto_docs/google/longrunning/operations.rb
117
118
  - proto_docs/google/protobuf/any.rb
118
119
  - proto_docs/google/protobuf/duration.rb
@@ -125,7 +126,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
125
126
  licenses:
126
127
  - Apache-2.0
127
128
  metadata: {}
128
- post_install_message:
129
129
  rdoc_options: []
130
130
  require_paths:
131
131
  - lib
@@ -133,15 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
133
133
  requirements:
134
134
  - - ">="
135
135
  - !ruby/object:Gem::Version
136
- version: '2.7'
136
+ version: '3.0'
137
137
  required_rubygems_version: !ruby/object:Gem::Requirement
138
138
  requirements:
139
139
  - - ">="
140
140
  - !ruby/object:Gem::Version
141
141
  version: '0'
142
142
  requirements: []
143
- rubygems_version: 3.5.23
144
- signing_key:
143
+ rubygems_version: 3.6.5
145
144
  specification_version: 4
146
145
  summary: Accesses the NoSQL document database built for automatic scaling, high performance,
147
146
  and ease of application development.