google-apis-firestore_v1 0.75.0 → 0.76.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9a95a6283157fc2a123299c09ff982cecb55f6b0506f99d21d4dad50fc59128e
4
- data.tar.gz: f9ed606ead34f5f83b5da91893196e34d19dd379aa2854a5c8e64b971d773924
3
+ metadata.gz: 183470f8e0ff52e2262899ef08c18612646d9848c980dc34f984443e4b1db395
4
+ data.tar.gz: a96a7ef5f14d7005ab379eda5ad905d1deda3eaa6aa170e34ebb2d3c84227f25
5
5
  SHA512:
6
- metadata.gz: ba6d69f291afea7ffccaacd9c0feaa66176cf69285c04f81a416bb7df46d089812c8603380cf052602894048845424616808f66b290acaf4982ec584f913c9d4
7
- data.tar.gz: b8699ca78e1898356a6a66d54760830bff9ffd24bb7e3ec5f3e8afbae0ba3fe26fb56899f7b36693cdc4e152bba0e51bdecd671cbf6b32165146030a573f1679
6
+ metadata.gz: 49fbcb424c023e113e6310b3c1135dbe2eb25fdabd6f2cc85169458a8dee09e42b0a941f3204606e96e58c66f3216b8e5cd0a24bb06c1bd29a9907d2d999a744
7
+ data.tar.gz: e3b72b9c10545380d3b24b3b2a4f304e37cb2d03cc813cbcb85875c391b4d3358c6db01fa78b4d713cfb3d51c1c266eda1fc93d399896ab1d2036634e54fd20a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-firestore_v1
2
2
 
3
+ ### v0.76.0 (2025-04-20)
4
+
5
+ * Regenerated from discovery document revision 20250414
6
+
3
7
  ### v0.75.0 (2025-03-16)
4
8
 
5
9
  * Regenerated from discovery document revision 20250307
@@ -1509,6 +1509,11 @@ module Google
1509
1509
  # @return [String]
1510
1510
  attr_accessor :create_time
1511
1511
 
1512
+ # Immutable. The edition of the database.
1513
+ # Corresponds to the JSON property `databaseEdition`
1514
+ # @return [String]
1515
+ attr_accessor :database_edition
1516
+
1512
1517
  # State of delete protection for the database.
1513
1518
  # Corresponds to the JSON property `deleteProtectionState`
1514
1519
  # @return [String]
@@ -1537,6 +1542,19 @@ module Google
1537
1542
  # @return [String]
1538
1543
  attr_accessor :etag
1539
1544
 
1545
+ # Output only. Background: Free tier is the ability of a Firestore database to
1546
+ # use a small amount of resources every day without being charged. Once usage
1547
+ # exceeds the free tier limit further usage is charged. Whether this database
1548
+ # can make use of the free tier. Only one database per project can be eligible
1549
+ # for the free tier. The first (or next) database that is created in a project
1550
+ # without a free tier database will be marked as eligible for the free tier.
1551
+ # Databases that are created while there is a free tier database will not be
1552
+ # eligible for the free tier.
1553
+ # Corresponds to the JSON property `freeTier`
1554
+ # @return [Boolean]
1555
+ attr_accessor :free_tier
1556
+ alias_method :free_tier?, :free_tier
1557
+
1540
1558
  # Output only. The key_prefix for this database. This key_prefix is used, in
1541
1559
  # combination with the project ID ("~") to construct the application ID that is
1542
1560
  # returned from the Cloud Datastore APIs in Google App Engine first generation
@@ -1574,6 +1592,13 @@ module Google
1574
1592
  # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo]
1575
1593
  attr_accessor :source_info
1576
1594
 
1595
+ # Optional. Input only. Immutable. Tag keys/values directly bound to this
1596
+ # resource. For example: "123/environment": "production", "123/costCenter": "
1597
+ # marketing"
1598
+ # Corresponds to the JSON property `tags`
1599
+ # @return [Hash<String,String>]
1600
+ attr_accessor :tags
1601
+
1577
1602
  # The type of the database. See https://cloud.google.com/datastore/docs/
1578
1603
  # firestore-or-datastore for information about how to choose.
1579
1604
  # Corresponds to the JSON property `type`
@@ -1611,16 +1636,19 @@ module Google
1611
1636
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
1612
1637
  @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
1613
1638
  @create_time = args[:create_time] if args.key?(:create_time)
1639
+ @database_edition = args[:database_edition] if args.key?(:database_edition)
1614
1640
  @delete_protection_state = args[:delete_protection_state] if args.key?(:delete_protection_state)
1615
1641
  @delete_time = args[:delete_time] if args.key?(:delete_time)
1616
1642
  @earliest_version_time = args[:earliest_version_time] if args.key?(:earliest_version_time)
1617
1643
  @etag = args[:etag] if args.key?(:etag)
1644
+ @free_tier = args[:free_tier] if args.key?(:free_tier)
1618
1645
  @key_prefix = args[:key_prefix] if args.key?(:key_prefix)
1619
1646
  @location_id = args[:location_id] if args.key?(:location_id)
1620
1647
  @name = args[:name] if args.key?(:name)
1621
1648
  @point_in_time_recovery_enablement = args[:point_in_time_recovery_enablement] if args.key?(:point_in_time_recovery_enablement)
1622
1649
  @previous_id = args[:previous_id] if args.key?(:previous_id)
1623
1650
  @source_info = args[:source_info] if args.key?(:source_info)
1651
+ @tags = args[:tags] if args.key?(:tags)
1624
1652
  @type = args[:type] if args.key?(:type)
1625
1653
  @uid = args[:uid] if args.key?(:uid)
1626
1654
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -1641,6 +1669,32 @@ module Google
1641
1669
  end
1642
1670
  end
1643
1671
 
1672
+ # The request for FirestoreAdmin.DisableUserCreds.
1673
+ class GoogleFirestoreAdminV1DisableUserCredsRequest
1674
+ include Google::Apis::Core::Hashable
1675
+
1676
+ def initialize(**args)
1677
+ update!(**args)
1678
+ end
1679
+
1680
+ # Update properties of this object
1681
+ def update!(**args)
1682
+ end
1683
+ end
1684
+
1685
+ # The request for FirestoreAdmin.EnableUserCreds.
1686
+ class GoogleFirestoreAdminV1EnableUserCredsRequest
1687
+ include Google::Apis::Core::Hashable
1688
+
1689
+ def initialize(**args)
1690
+ update!(**args)
1691
+ end
1692
+
1693
+ # Update properties of this object
1694
+ def update!(**args)
1695
+ end
1696
+ end
1697
+
1644
1698
  # Encryption configuration for a new database being created from another source.
1645
1699
  # The source could be a Backup .
1646
1700
  class GoogleFirestoreAdminV1EncryptionConfig
@@ -2079,6 +2133,11 @@ module Google
2079
2133
  # @return [String]
2080
2134
  attr_accessor :api_scope
2081
2135
 
2136
+ # Immutable. The density configuration of the index.
2137
+ # Corresponds to the JSON property `density`
2138
+ # @return [String]
2139
+ attr_accessor :density
2140
+
2082
2141
  # The fields supported by this index. For composite indexes, this requires a
2083
2142
  # minimum of 2 and a maximum of 100 fields. The last field entry is always for
2084
2143
  # the field path `__name__`. If, on creation, `__name__` was not specified as
@@ -2091,6 +2150,17 @@ module Google
2091
2150
  # @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField>]
2092
2151
  attr_accessor :fields
2093
2152
 
2153
+ # Optional. Whether the index is multikey. By default, the index is not multikey.
2154
+ # For non-multikey indexes, none of the paths in the index definition reach or
2155
+ # traverse an array, except via an explicit array index. For multikey indexes,
2156
+ # at most one of the paths in the index definition reach or traverse an array,
2157
+ # except via an explicit array index. Violations will result in errors. Note
2158
+ # this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.
2159
+ # Corresponds to the JSON property `multikey`
2160
+ # @return [Boolean]
2161
+ attr_accessor :multikey
2162
+ alias_method :multikey?, :multikey
2163
+
2094
2164
  # Output only. A server defined name for this index. The form of this name for
2095
2165
  # composite indexes will be: `projects/`project_id`/databases/`database_id`/
2096
2166
  # collectionGroups/`collection_id`/indexes/`composite_index_id`` For single
@@ -2109,6 +2179,11 @@ module Google
2109
2179
  # @return [String]
2110
2180
  attr_accessor :query_scope
2111
2181
 
2182
+ # Optional. The number of shards for the index.
2183
+ # Corresponds to the JSON property `shardCount`
2184
+ # @return [Fixnum]
2185
+ attr_accessor :shard_count
2186
+
2112
2187
  # Output only. The serving state of the index.
2113
2188
  # Corresponds to the JSON property `state`
2114
2189
  # @return [String]
@@ -2121,9 +2196,12 @@ module Google
2121
2196
  # Update properties of this object
2122
2197
  def update!(**args)
2123
2198
  @api_scope = args[:api_scope] if args.key?(:api_scope)
2199
+ @density = args[:density] if args.key?(:density)
2124
2200
  @fields = args[:fields] if args.key?(:fields)
2201
+ @multikey = args[:multikey] if args.key?(:multikey)
2125
2202
  @name = args[:name] if args.key?(:name)
2126
2203
  @query_scope = args[:query_scope] if args.key?(:query_scope)
2204
+ @shard_count = args[:shard_count] if args.key?(:shard_count)
2127
2205
  @state = args[:state] if args.key?(:state)
2128
2206
  end
2129
2207
  end
@@ -2427,6 +2505,25 @@ module Google
2427
2505
  end
2428
2506
  end
2429
2507
 
2508
+ # The response for FirestoreAdmin.ListUserCreds.
2509
+ class GoogleFirestoreAdminV1ListUserCredsResponse
2510
+ include Google::Apis::Core::Hashable
2511
+
2512
+ # The user creds for the database.
2513
+ # Corresponds to the JSON property `userCreds`
2514
+ # @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds>]
2515
+ attr_accessor :user_creds
2516
+
2517
+ def initialize(**args)
2518
+ update!(**args)
2519
+ end
2520
+
2521
+ # Update properties of this object
2522
+ def update!(**args)
2523
+ @user_creds = args[:user_creds] if args.key?(:user_creds)
2524
+ end
2525
+ end
2526
+
2430
2527
  # The metadata message for google.cloud.location.Location.metadata.
2431
2528
  class GoogleFirestoreAdminV1LocationMetadata
2432
2529
  include Google::Apis::Core::Hashable
@@ -2466,6 +2563,39 @@ module Google
2466
2563
  end
2467
2564
  end
2468
2565
 
2566
+ # The request for FirestoreAdmin.ResetUserPassword.
2567
+ class GoogleFirestoreAdminV1ResetUserPasswordRequest
2568
+ include Google::Apis::Core::Hashable
2569
+
2570
+ def initialize(**args)
2571
+ update!(**args)
2572
+ end
2573
+
2574
+ # Update properties of this object
2575
+ def update!(**args)
2576
+ end
2577
+ end
2578
+
2579
+ # Describes a Resource Identity principal.
2580
+ class GoogleFirestoreAdminV1ResourceIdentity
2581
+ include Google::Apis::Core::Hashable
2582
+
2583
+ # Output only. Principal identifier string. See: https://cloud.google.com/iam/
2584
+ # docs/principal-identifiers
2585
+ # Corresponds to the JSON property `principal`
2586
+ # @return [String]
2587
+ attr_accessor :principal
2588
+
2589
+ def initialize(**args)
2590
+ update!(**args)
2591
+ end
2592
+
2593
+ # Update properties of this object
2594
+ def update!(**args)
2595
+ @principal = args[:principal] if args.key?(:principal)
2596
+ end
2597
+ end
2598
+
2469
2599
  # Metadata for the long-running operation from the RestoreDatabase request.
2470
2600
  class GoogleFirestoreAdminV1RestoreDatabaseMetadata
2471
2601
  include Google::Apis::Core::Hashable
@@ -2544,6 +2674,13 @@ module Google
2544
2674
  # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig]
2545
2675
  attr_accessor :encryption_config
2546
2676
 
2677
+ # Optional. Immutable. Tags to be bound to the restored database. The tags
2678
+ # should be provided in the format of `tagKeys/`tag_key_id` -> tagValues/`
2679
+ # tag_value_id``.
2680
+ # Corresponds to the JSON property `tags`
2681
+ # @return [Hash<String,String>]
2682
+ attr_accessor :tags
2683
+
2547
2684
  def initialize(**args)
2548
2685
  update!(**args)
2549
2686
  end
@@ -2553,6 +2690,7 @@ module Google
2553
2690
  @backup = args[:backup] if args.key?(:backup)
2554
2691
  @database_id = args[:database_id] if args.key?(:database_id)
2555
2692
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
2693
+ @tags = args[:tags] if args.key?(:tags)
2556
2694
  end
2557
2695
  end
2558
2696
 
@@ -2684,6 +2822,58 @@ module Google
2684
2822
  end
2685
2823
  end
2686
2824
 
2825
+ # A Cloud Firestore User Creds.
2826
+ class GoogleFirestoreAdminV1UserCreds
2827
+ include Google::Apis::Core::Hashable
2828
+
2829
+ # Output only. The time the user creds were created.
2830
+ # Corresponds to the JSON property `createTime`
2831
+ # @return [String]
2832
+ attr_accessor :create_time
2833
+
2834
+ # Identifier. The resource name of the UserCreds. Format: `projects/`project`/
2835
+ # databases/`database`/userCreds/`user_creds``
2836
+ # Corresponds to the JSON property `name`
2837
+ # @return [String]
2838
+ attr_accessor :name
2839
+
2840
+ # Describes a Resource Identity principal.
2841
+ # Corresponds to the JSON property `resourceIdentity`
2842
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResourceIdentity]
2843
+ attr_accessor :resource_identity
2844
+
2845
+ # Output only. The plaintext server-generated password for the user creds. Only
2846
+ # populated in responses for CreateUserCreds and ResetUserPassword.
2847
+ # Corresponds to the JSON property `securePassword`
2848
+ # @return [String]
2849
+ attr_accessor :secure_password
2850
+
2851
+ # Output only. Whether the user creds are enabled or disabled. Defaults to
2852
+ # ENABLED on creation.
2853
+ # Corresponds to the JSON property `state`
2854
+ # @return [String]
2855
+ attr_accessor :state
2856
+
2857
+ # Output only. The time the user creds were last updated.
2858
+ # Corresponds to the JSON property `updateTime`
2859
+ # @return [String]
2860
+ attr_accessor :update_time
2861
+
2862
+ def initialize(**args)
2863
+ update!(**args)
2864
+ end
2865
+
2866
+ # Update properties of this object
2867
+ def update!(**args)
2868
+ @create_time = args[:create_time] if args.key?(:create_time)
2869
+ @name = args[:name] if args.key?(:name)
2870
+ @resource_identity = args[:resource_identity] if args.key?(:resource_identity)
2871
+ @secure_password = args[:secure_password] if args.key?(:secure_password)
2872
+ @state = args[:state] if args.key?(:state)
2873
+ @update_time = args[:update_time] if args.key?(:update_time)
2874
+ end
2875
+ end
2876
+
2687
2877
  # The index configuration to support vector search operations
2688
2878
  class GoogleFirestoreAdminV1VectorConfig
2689
2879
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirestoreV1
18
18
  # Version of the google-apis-firestore_v1 gem
19
- GEM_VERSION = "0.75.0"
19
+ GEM_VERSION = "0.76.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.16.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250307"
25
+ REVISION = "20250414"
26
26
  end
27
27
  end
28
28
  end
@@ -298,6 +298,18 @@ module Google
298
298
  include Google::Apis::Core::JsonObjectSupport
299
299
  end
300
300
 
301
+ class GoogleFirestoreAdminV1DisableUserCredsRequest
302
+ class Representation < Google::Apis::Core::JsonRepresentation; end
303
+
304
+ include Google::Apis::Core::JsonObjectSupport
305
+ end
306
+
307
+ class GoogleFirestoreAdminV1EnableUserCredsRequest
308
+ class Representation < Google::Apis::Core::JsonRepresentation; end
309
+
310
+ include Google::Apis::Core::JsonObjectSupport
311
+ end
312
+
301
313
  class GoogleFirestoreAdminV1EncryptionConfig
302
314
  class Representation < Google::Apis::Core::JsonRepresentation; end
303
315
 
@@ -418,6 +430,12 @@ module Google
418
430
  include Google::Apis::Core::JsonObjectSupport
419
431
  end
420
432
 
433
+ class GoogleFirestoreAdminV1ListUserCredsResponse
434
+ class Representation < Google::Apis::Core::JsonRepresentation; end
435
+
436
+ include Google::Apis::Core::JsonObjectSupport
437
+ end
438
+
421
439
  class GoogleFirestoreAdminV1LocationMetadata
422
440
  class Representation < Google::Apis::Core::JsonRepresentation; end
423
441
 
@@ -430,6 +448,18 @@ module Google
430
448
  include Google::Apis::Core::JsonObjectSupport
431
449
  end
432
450
 
451
+ class GoogleFirestoreAdminV1ResetUserPasswordRequest
452
+ class Representation < Google::Apis::Core::JsonRepresentation; end
453
+
454
+ include Google::Apis::Core::JsonObjectSupport
455
+ end
456
+
457
+ class GoogleFirestoreAdminV1ResourceIdentity
458
+ class Representation < Google::Apis::Core::JsonRepresentation; end
459
+
460
+ include Google::Apis::Core::JsonObjectSupport
461
+ end
462
+
433
463
  class GoogleFirestoreAdminV1RestoreDatabaseMetadata
434
464
  class Representation < Google::Apis::Core::JsonRepresentation; end
435
465
 
@@ -478,6 +508,12 @@ module Google
478
508
  include Google::Apis::Core::JsonObjectSupport
479
509
  end
480
510
 
511
+ class GoogleFirestoreAdminV1UserCreds
512
+ class Representation < Google::Apis::Core::JsonRepresentation; end
513
+
514
+ include Google::Apis::Core::JsonObjectSupport
515
+ end
516
+
481
517
  class GoogleFirestoreAdminV1VectorConfig
482
518
  class Representation < Google::Apis::Core::JsonRepresentation; end
483
519
 
@@ -1148,10 +1184,12 @@ module Google
1148
1184
 
1149
1185
  property :concurrency_mode, as: 'concurrencyMode'
1150
1186
  property :create_time, as: 'createTime'
1187
+ property :database_edition, as: 'databaseEdition'
1151
1188
  property :delete_protection_state, as: 'deleteProtectionState'
1152
1189
  property :delete_time, as: 'deleteTime'
1153
1190
  property :earliest_version_time, as: 'earliestVersionTime'
1154
1191
  property :etag, as: 'etag'
1192
+ property :free_tier, as: 'freeTier'
1155
1193
  property :key_prefix, as: 'keyPrefix'
1156
1194
  property :location_id, as: 'locationId'
1157
1195
  property :name, as: 'name'
@@ -1159,6 +1197,7 @@ module Google
1159
1197
  property :previous_id, as: 'previousId'
1160
1198
  property :source_info, as: 'sourceInfo', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo::Representation
1161
1199
 
1200
+ hash :tags, as: 'tags'
1162
1201
  property :type, as: 'type'
1163
1202
  property :uid, as: 'uid'
1164
1203
  property :update_time, as: 'updateTime'
@@ -1172,6 +1211,18 @@ module Google
1172
1211
  end
1173
1212
  end
1174
1213
 
1214
+ class GoogleFirestoreAdminV1DisableUserCredsRequest
1215
+ # @private
1216
+ class Representation < Google::Apis::Core::JsonRepresentation
1217
+ end
1218
+ end
1219
+
1220
+ class GoogleFirestoreAdminV1EnableUserCredsRequest
1221
+ # @private
1222
+ class Representation < Google::Apis::Core::JsonRepresentation
1223
+ end
1224
+ end
1225
+
1175
1226
  class GoogleFirestoreAdminV1EncryptionConfig
1176
1227
  # @private
1177
1228
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1288,10 +1339,13 @@ module Google
1288
1339
  # @private
1289
1340
  class Representation < Google::Apis::Core::JsonRepresentation
1290
1341
  property :api_scope, as: 'apiScope'
1342
+ property :density, as: 'density'
1291
1343
  collection :fields, as: 'fields', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField::Representation
1292
1344
 
1345
+ property :multikey, as: 'multikey'
1293
1346
  property :name, as: 'name'
1294
1347
  property :query_scope, as: 'queryScope'
1348
+ property :shard_count, as: 'shardCount'
1295
1349
  property :state, as: 'state'
1296
1350
  end
1297
1351
  end
@@ -1385,6 +1439,14 @@ module Google
1385
1439
  end
1386
1440
  end
1387
1441
 
1442
+ class GoogleFirestoreAdminV1ListUserCredsResponse
1443
+ # @private
1444
+ class Representation < Google::Apis::Core::JsonRepresentation
1445
+ collection :user_creds, as: 'userCreds', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1446
+
1447
+ end
1448
+ end
1449
+
1388
1450
  class GoogleFirestoreAdminV1LocationMetadata
1389
1451
  # @private
1390
1452
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1399,6 +1461,19 @@ module Google
1399
1461
  end
1400
1462
  end
1401
1463
 
1464
+ class GoogleFirestoreAdminV1ResetUserPasswordRequest
1465
+ # @private
1466
+ class Representation < Google::Apis::Core::JsonRepresentation
1467
+ end
1468
+ end
1469
+
1470
+ class GoogleFirestoreAdminV1ResourceIdentity
1471
+ # @private
1472
+ class Representation < Google::Apis::Core::JsonRepresentation
1473
+ property :principal, as: 'principal'
1474
+ end
1475
+ end
1476
+
1402
1477
  class GoogleFirestoreAdminV1RestoreDatabaseMetadata
1403
1478
  # @private
1404
1479
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1419,6 +1494,7 @@ module Google
1419
1494
  property :database_id, as: 'databaseId'
1420
1495
  property :encryption_config, as: 'encryptionConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig::Representation
1421
1496
 
1497
+ hash :tags, as: 'tags'
1422
1498
  end
1423
1499
  end
1424
1500
 
@@ -1466,6 +1542,19 @@ module Google
1466
1542
  end
1467
1543
  end
1468
1544
 
1545
+ class GoogleFirestoreAdminV1UserCreds
1546
+ # @private
1547
+ class Representation < Google::Apis::Core::JsonRepresentation
1548
+ property :create_time, as: 'createTime'
1549
+ property :name, as: 'name'
1550
+ property :resource_identity, as: 'resourceIdentity', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResourceIdentity, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResourceIdentity::Representation
1551
+
1552
+ property :secure_password, as: 'securePassword'
1553
+ property :state, as: 'state'
1554
+ property :update_time, as: 'updateTime'
1555
+ end
1556
+ end
1557
+
1469
1558
  class GoogleFirestoreAdminV1VectorConfig
1470
1559
  # @private
1471
1560
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1697,6 +1697,244 @@ module Google
1697
1697
  execute_or_queue_command(command, &block)
1698
1698
  end
1699
1699
 
1700
+ # Create a user creds.
1701
+ # @param [String] parent
1702
+ # Required. A parent name of the form `projects/`project_id`/databases/`
1703
+ # database_id``
1704
+ # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds] google_firestore_admin_v1_user_creds_object
1705
+ # @param [String] user_creds_id
1706
+ # Required. The ID to use for the user creds, which will become the final
1707
+ # component of the user creds's resource name. This value should be 4-63
1708
+ # characters. Valid characters are /a-z-/ with first character a letter and the
1709
+ # last a letter or a number. Must not be UUID-like /[0-9a-f]`8`(-[0-9a-f]`4`)`3`-
1710
+ # [0-9a-f]`12`/.
1711
+ # @param [String] fields
1712
+ # Selector specifying which fields to include in a partial response.
1713
+ # @param [String] quota_user
1714
+ # Available to use for quota purposes for server-side applications. Can be any
1715
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1716
+ # @param [Google::Apis::RequestOptions] options
1717
+ # Request-specific options
1718
+ #
1719
+ # @yield [result, err] Result & error if block supplied
1720
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds] parsed result object
1721
+ # @yieldparam err [StandardError] error object if request failed
1722
+ #
1723
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds]
1724
+ #
1725
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1726
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1727
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1728
+ def create_project_database_user_cred(parent, google_firestore_admin_v1_user_creds_object = nil, user_creds_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1729
+ command = make_simple_command(:post, 'v1/{+parent}/userCreds', options)
1730
+ command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1731
+ command.request_object = google_firestore_admin_v1_user_creds_object
1732
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1733
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
1734
+ command.params['parent'] = parent unless parent.nil?
1735
+ command.query['userCredsId'] = user_creds_id unless user_creds_id.nil?
1736
+ command.query['fields'] = fields unless fields.nil?
1737
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1738
+ execute_or_queue_command(command, &block)
1739
+ end
1740
+
1741
+ # Deletes a user creds.
1742
+ # @param [String] name
1743
+ # Required. A name of the form `projects/`project_id`/databases/`database_id`/
1744
+ # userCreds/`user_creds_id``
1745
+ # @param [String] fields
1746
+ # Selector specifying which fields to include in a partial response.
1747
+ # @param [String] quota_user
1748
+ # Available to use for quota purposes for server-side applications. Can be any
1749
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1750
+ # @param [Google::Apis::RequestOptions] options
1751
+ # Request-specific options
1752
+ #
1753
+ # @yield [result, err] Result & error if block supplied
1754
+ # @yieldparam result [Google::Apis::FirestoreV1::Empty] parsed result object
1755
+ # @yieldparam err [StandardError] error object if request failed
1756
+ #
1757
+ # @return [Google::Apis::FirestoreV1::Empty]
1758
+ #
1759
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1760
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1761
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1762
+ def delete_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil, &block)
1763
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1764
+ command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
1765
+ command.response_class = Google::Apis::FirestoreV1::Empty
1766
+ command.params['name'] = name unless name.nil?
1767
+ command.query['fields'] = fields unless fields.nil?
1768
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1769
+ execute_or_queue_command(command, &block)
1770
+ end
1771
+
1772
+ # Disables a user creds. No-op if the user creds are already disabled.
1773
+ # @param [String] name
1774
+ # Required. A name of the form `projects/`project_id`/databases/`database_id`/
1775
+ # userCreds/`user_creds_id``
1776
+ # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DisableUserCredsRequest] google_firestore_admin_v1_disable_user_creds_request_object
1777
+ # @param [String] fields
1778
+ # Selector specifying which fields to include in a partial response.
1779
+ # @param [String] quota_user
1780
+ # Available to use for quota purposes for server-side applications. Can be any
1781
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1782
+ # @param [Google::Apis::RequestOptions] options
1783
+ # Request-specific options
1784
+ #
1785
+ # @yield [result, err] Result & error if block supplied
1786
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds] parsed result object
1787
+ # @yieldparam err [StandardError] error object if request failed
1788
+ #
1789
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds]
1790
+ #
1791
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1792
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1793
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1794
+ def disable_project_database_user_cred(name, google_firestore_admin_v1_disable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1795
+ command = make_simple_command(:post, 'v1/{+name}:disable', options)
1796
+ command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DisableUserCredsRequest::Representation
1797
+ command.request_object = google_firestore_admin_v1_disable_user_creds_request_object
1798
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1799
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
1800
+ command.params['name'] = name unless name.nil?
1801
+ command.query['fields'] = fields unless fields.nil?
1802
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1803
+ execute_or_queue_command(command, &block)
1804
+ end
1805
+
1806
+ # Enables a user creds. No-op if the user creds are already enabled.
1807
+ # @param [String] name
1808
+ # Required. A name of the form `projects/`project_id`/databases/`database_id`/
1809
+ # userCreds/`user_creds_id``
1810
+ # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EnableUserCredsRequest] google_firestore_admin_v1_enable_user_creds_request_object
1811
+ # @param [String] fields
1812
+ # Selector specifying which fields to include in a partial response.
1813
+ # @param [String] quota_user
1814
+ # Available to use for quota purposes for server-side applications. Can be any
1815
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1816
+ # @param [Google::Apis::RequestOptions] options
1817
+ # Request-specific options
1818
+ #
1819
+ # @yield [result, err] Result & error if block supplied
1820
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds] parsed result object
1821
+ # @yieldparam err [StandardError] error object if request failed
1822
+ #
1823
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds]
1824
+ #
1825
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1826
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1827
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1828
+ def enable_project_database_user_cred(name, google_firestore_admin_v1_enable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1829
+ command = make_simple_command(:post, 'v1/{+name}:enable', options)
1830
+ command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EnableUserCredsRequest::Representation
1831
+ command.request_object = google_firestore_admin_v1_enable_user_creds_request_object
1832
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1833
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
1834
+ command.params['name'] = name unless name.nil?
1835
+ command.query['fields'] = fields unless fields.nil?
1836
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1837
+ execute_or_queue_command(command, &block)
1838
+ end
1839
+
1840
+ # Gets a user creds resource. Note that the returned resource does not contain
1841
+ # the secret value itself.
1842
+ # @param [String] name
1843
+ # Required. A name of the form `projects/`project_id`/databases/`database_id`/
1844
+ # userCreds/`user_creds_id``
1845
+ # @param [String] fields
1846
+ # Selector specifying which fields to include in a partial response.
1847
+ # @param [String] quota_user
1848
+ # Available to use for quota purposes for server-side applications. Can be any
1849
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1850
+ # @param [Google::Apis::RequestOptions] options
1851
+ # Request-specific options
1852
+ #
1853
+ # @yield [result, err] Result & error if block supplied
1854
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds] parsed result object
1855
+ # @yieldparam err [StandardError] error object if request failed
1856
+ #
1857
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds]
1858
+ #
1859
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1860
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1861
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1862
+ def get_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil, &block)
1863
+ command = make_simple_command(:get, 'v1/{+name}', options)
1864
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1865
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
1866
+ command.params['name'] = name unless name.nil?
1867
+ command.query['fields'] = fields unless fields.nil?
1868
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1869
+ execute_or_queue_command(command, &block)
1870
+ end
1871
+
1872
+ # List all user creds in the database. Note that the returned resource does not
1873
+ # contain the secret value itself.
1874
+ # @param [String] parent
1875
+ # Required. A parent database name of the form `projects/`project_id`/databases/`
1876
+ # database_id``
1877
+ # @param [String] fields
1878
+ # Selector specifying which fields to include in a partial response.
1879
+ # @param [String] quota_user
1880
+ # Available to use for quota purposes for server-side applications. Can be any
1881
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1882
+ # @param [Google::Apis::RequestOptions] options
1883
+ # Request-specific options
1884
+ #
1885
+ # @yield [result, err] Result & error if block supplied
1886
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse] parsed result object
1887
+ # @yieldparam err [StandardError] error object if request failed
1888
+ #
1889
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse]
1890
+ #
1891
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1892
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1893
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1894
+ def list_project_database_user_creds(parent, fields: nil, quota_user: nil, options: nil, &block)
1895
+ command = make_simple_command(:get, 'v1/{+parent}/userCreds', options)
1896
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse::Representation
1897
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse
1898
+ command.params['parent'] = parent unless parent.nil?
1899
+ command.query['fields'] = fields unless fields.nil?
1900
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1901
+ execute_or_queue_command(command, &block)
1902
+ end
1903
+
1904
+ # Resets the password of a user creds.
1905
+ # @param [String] name
1906
+ # Required. A name of the form `projects/`project_id`/databases/`database_id`/
1907
+ # userCreds/`user_creds_id``
1908
+ # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResetUserPasswordRequest] google_firestore_admin_v1_reset_user_password_request_object
1909
+ # @param [String] fields
1910
+ # Selector specifying which fields to include in a partial response.
1911
+ # @param [String] quota_user
1912
+ # Available to use for quota purposes for server-side applications. Can be any
1913
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1914
+ # @param [Google::Apis::RequestOptions] options
1915
+ # Request-specific options
1916
+ #
1917
+ # @yield [result, err] Result & error if block supplied
1918
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds] parsed result object
1919
+ # @yieldparam err [StandardError] error object if request failed
1920
+ #
1921
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds]
1922
+ #
1923
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1924
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1925
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1926
+ def reset_project_database_user_cred_password(name, google_firestore_admin_v1_reset_user_password_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1927
+ command = make_simple_command(:post, 'v1/{+name}:resetPassword', options)
1928
+ command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResetUserPasswordRequest::Representation
1929
+ command.request_object = google_firestore_admin_v1_reset_user_password_request_object
1930
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
1931
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
1932
+ command.params['name'] = name unless name.nil?
1933
+ command.query['fields'] = fields unless fields.nil?
1934
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1935
+ execute_or_queue_command(command, &block)
1936
+ end
1937
+
1700
1938
  # Gets information about a location.
1701
1939
  # @param [String] name
1702
1940
  # Resource name for the location.
@@ -1730,6 +1968,9 @@ module Google
1730
1968
  # Lists information about the supported locations for this service.
1731
1969
  # @param [String] name
1732
1970
  # The resource that owns the locations collection, if applicable.
1971
+ # @param [Array<String>, String] extra_location_types
1972
+ # Optional. A list of extra location types that should be used as conditions for
1973
+ # controlling the visibility of the locations.
1733
1974
  # @param [String] filter
1734
1975
  # A filter to narrow down results to a preferred subset. The filtering language
1735
1976
  # accepts strings like `"displayName=tokyo"`, and is documented in more detail
@@ -1757,11 +1998,12 @@ module Google
1757
1998
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1758
1999
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1759
2000
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1760
- def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2001
+ def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1761
2002
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
1762
2003
  command.response_representation = Google::Apis::FirestoreV1::ListLocationsResponse::Representation
1763
2004
  command.response_class = Google::Apis::FirestoreV1::ListLocationsResponse
1764
2005
  command.params['name'] = name unless name.nil?
2006
+ command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
1765
2007
  command.query['filter'] = filter unless filter.nil?
1766
2008
  command.query['pageSize'] = page_size unless page_size.nil?
1767
2009
  command.query['pageToken'] = page_token unless page_token.nil?
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firestore_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.75.0
4
+ version: 0.76.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-16 00:00:00.000000000 Z
10
+ date: 2025-04-20 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.75.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.76.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
62
62
  rdoc_options: []
63
63
  require_paths: